0

0

如何配置Java的Swagger接口文档环境_Springfox依赖集成

P粉602998670

P粉602998670

发布时间:2026-03-11 15:08:02

|

406人浏览过

|

来源于php中文网

原创

springfox 3.x 在 spring boot 2.6+ 需配置 spring.mvc.throw-exception-if-no-handler-found: false 且 spring.resources.add-mappings: true,访问路径为 /swagger-ui/;spring boot 3.x 不兼容 springfox,须迁移到 springdoc-openapi。

如何配置java的swagger接口文档环境_springfox依赖集成

Springfox 3.x 在 Spring Boot 2.6+ 启动就报 NoHandlerFoundException

Spring Boot 2.6 默认启用了 spring.mvc.throw-exception-if-no-handler-found=true,而 Springfox 3.x 的 Docket 注册的静态资源(如 /swagger-ui.html)没被 MVC 资源处理器识别,导致 404 直接抛异常,页面打不开。

  • application.yml 中显式关闭该开关:
    spring:
      mvc:
        throw-exception-if-no-handler-found: false
      resources:
        add-mappings: true
  • 同时必须保留 spring.resources.add-mappings: true,否则 /webjars/** 路径下的 Swagger UI 静态资源根本不会注册
  • 别信某些博客说“加个 @EnableWebMvc 就行”——那会彻底禁用 Spring Boot 的自动配置,得自己配资源处理器,得不偿失

Swagger UI 访问 404,但后端接口能正常返回 JSON

说明 springfox-swagger2springfox-swagger-ui 依赖已生效,但前端资源路径没对上。Springfox 3.x 把 UI 入口从 /swagger-ui.html 改成了 /swagger-ui/(末尾带斜杠),且依赖 /webjars/swagger-ui/index.html 重定向。

  • 确认引入的是 springfox-swagger-ui(不是 swagger-ui 单独 jar)
  • 访问地址必须是 http://localhost:8080/swagger-ui/,少斜杠、多 .html 或写成 /swagger-ui/index.html 都会 404
  • 如果用了网关或反向代理,检查是否过滤了 /webjars/** 路径(Nginx 常见漏配 location /webjars

Docket 配置里 select().apis() 不生效

常见于扫描不到 Controller——不是注解没加,而是 RequestHandlerSelectors 的匹配逻辑太严格,默认只认 @Api@RestController,但如果你用的是 @Controller + @ResponseBody,它直接跳过。

IBM Watson
IBM Watson

IBM Watson文字转语音

下载
  • 稳妥写法是用 RequestHandlerSelectors.basePackage("com.example.api") 明确指定包路径
  • 避免用 any(),它会把 Actuator、Spring Security 的内部 endpoint 也扫进来,生成大量无意义接口
  • 如果 Controller 有泛型参数(比如 BaseController<t></t>),Springfox 3.x 解析可能失败,接口消失——这时只能手动加 @Api 注解兜底

升级到 Spring Boot 3.x 后 Springfox 彻底跑不起来

Springfox 官方早在 2022 年就停止维护,最后一个版本 3.0.0 不支持 Jakarta EE 9+(即 jakarta.* 包名),而 Spring Boot 3.x 强制使用 Jakarta EE 9。编译可能过,但运行时会报 ClassNotFoundException: javax.servlet.http.HttpServletRequest

立即学习Java免费学习笔记(深入)”;

  • 没有兼容方案,springfox 在 Spring Boot 3.x 环境下就是不可用的
  • 必须迁移到 springdoc-openapi-starter-webmvc-ui(即 Swagger 3 / OpenAPI 3 实现)
  • 迁移成本不高:删掉所有 springfox 依赖和 @EnableSwagger2Docket 配置,加上新依赖后 /swagger-ui.html 自动可用(注意路径又变回带 .html 了)
Spring Boot 版本和 Springfox 版本耦合极紧,看错一个 patch 版本(比如 2.6.3 vs 2.6.7)都可能触发资源注册时机问题——别猜,直接查 Springfox 官方兼容表

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

156

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

88

2026.01.26

nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

246

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

522

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

610

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

244

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

693

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3618

2024.08.07

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4.3万人学习

C# 教程
C# 教程

共94课时 | 11.1万人学习

Java 教程
Java 教程

共578课时 | 80.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号