讲师中心 微信公众号
AI工具推荐 视频效率加速

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

秋磊姑娘_8296

秋磊姑娘_8296

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

|

546人浏览过

|

来源于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-swagger2 和 springfox-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,它直接跳过。

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
  • 稳妥写法是用 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 依赖和 @EnableSwagger2、Docket 配置,加上新依赖后 /swagger-ui.html 自动可用(注意路径又变回带 .html 了)
Spring Boot 版本和 Springfox 版本耦合极紧,看错一个 patch 版本(比如 2.6.3 vs 2.6.7)都可能触发资源注册时机问题——别猜,直接查 Springfox 官方兼容表。

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

10517

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

7642

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6672

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1144

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

928

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1376

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2769

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20071

2023.08.03

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

0

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn