0

0

如何在Spring Boot中集成Swagger生成接口文档_springfox与springdoc依赖选择

P粉602998670

P粉602998670

发布时间:2026-03-15 16:47:40

|

825人浏览过

|

来源于php中文网

原创

不能,Springfox 3.0 不兼容 Spring Boot 2.6+,因其未适配 PathPatternParser 路径匹配策略,启动报 NoClassDefFoundError 或 NoSuchMethodError;官方已停止维护,应改用 springdoc-openapi。

如何在spring boot中集成swagger生成接口文档_springfox与springdoc依赖选择

springfox 3.0 还能用吗?别选了,它已不兼容 Spring Boot 2.6+

不能。Spring Boot 2.6+ 默认启用了 spring.mvc.pathmatch.matching-strategy=ant_path_matcher 的替代策略(PathPatternParser),而 springfox 3.0.0 及之前所有版本压根没适配这个变更,启动直接报 NoClassDefFoundError: org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerMapping 或空指针。

常见错误现象:

  • 应用能启动,但访问 /swagger-ui.html 404 或白屏
  • 控制台刷出大量 Failed to start bean 'documentationPluginsBootstrapper'
  • Maven 编译无错,运行时报 java.lang.NoSuchMethodError(多因反射调用被移除的内部方法)

实操建议:

  • Spring Boot 2.6 及以后版本,彻底放弃 springfox —— 不是配置问题,是架构级不兼容
  • 若项目强依赖 springfox(如定制了大量 Docket 配置),降级 Spring Boot 到 2.5.x 是唯一“能跑”的临时方案,但会错过后续安全更新
  • springfox 官方自 2021 年起已停止维护,GitHub 上 issue 和 PR 基本无人处理

springdoc-openapi 是什么?它怎么替代 springfox

springdoc-openapi 是当前事实标准,它不侵入 Spring MVC 请求链路,而是通过 Spring Bean 扫描 + OpenAPI 3.0 规范生成器,在应用启动后动态构建文档模型,与 PathPatternParser 完全解耦。

使用场景:

  • 需要支持 Spring Boot 2.6+、3.x(包括 Jakarta EE 9+ 命名空间)
  • 想用原生 Swagger UI(/swagger-ui.html)或新版 HTML(/swagger-ui/index.html
  • 需对接第三方工具(如 Postman、Apifox)导入 OpenAPI JSON

实操建议:

  • 引入依赖:org.springdoc:springdoc-openapi-starter-webmvc-api:2.3.0(适配 Spring Boot 3.x)或 org.springdoc:springdoc-openapi-ui:1.6.14(适配 Spring Boot 2.6–2.7)
  • 无需额外配置类 —— 默认启用;如需开关,设 springdoc.api-docs.enabled=false
  • 接口注释仍可用 @Operation@Parameter(来自 io.swagger.v3.oas.annotations),和 springfox 的注解包名完全不同,不能混用

为什么 @ApiModel/@ApiModelProperty 不生效?注解体系已切换

因为 springdoc 完全不识别 springfoxio.swagger.annotations.* 注解,它们属于不同规范实现,包路径、语义、解析时机都不同。

标小智
标小智

智能LOGO设计生成器

下载

常见错误现象:

  • 实体类加了 @ApiModel,但文档里字段描述仍是 null 或默认名
  • DTO 字段用 @ApiModelProperty(required = true),但 Swagger UI 中未标红或未显示必填提示

实操建议:

  • 替换为 io.swagger.v3.oas.annotations.media.Schema(类/字段级描述)、io.swagger.v3.oas.annotations.media.ArraySchema(数组)
  • 字段必填写法:@Schema(requiredMode = Schema.RequiredMode.REQUIRED),不是布尔值
  • 枚举说明要配合 @Schema(implementation = MyEnum.class) + 枚举类上加 @Schema,否则只显示原始字符串
  • 如果旧项目迁移,建议写个简单脚本批量替换注解包名,避免手动漏改

本地能跑,上线 404?检查静态资源与路径前缀

Swagger UI 页面本质是静态资源,springdoc 默认将其挂载在 /swagger-ui/** 下,但若应用配置了 server.servlet.context-path 或反向代理(如 Nginx)重写了路径,就容易断链。

实操建议:

  • 确认访问地址:Spring Boot 2.6+ 默认是 http://host:port/context-path/swagger-ui/index.html(不是 /swagger-ui.html
  • 若用了 server.servlet.context-path=/api,则文档入口变为 /api/swagger-ui/index.html
  • Nginx 配置需透传 /swagger-ui//v3/api-docs 路径,例如:location /swagger-ui/ { proxy_pass http://backend/swagger-ui/; }
  • Spring Security 拦截时,记得放行:requestMatchers("/swagger-ui/**", "/v3/api-docs/**").permitAll()

最容易被忽略的是 Spring Boot 3.x 默认禁用 spring.web.resources.static-locations 的 classpath:/static 映射,但 springdoc 的 UI 资源走的是自己的 ResourceHandler,只要依赖正确引入就不会受影响——这点和旧版差异很大,不必额外配 static 路径。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

161

2025.08.06

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

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

89

2026.01.26

nginx 重启
nginx 重启

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

248

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、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

245

2024.02.23

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

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

737

2024.07.09

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

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

3619

2024.08.07

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

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

精品课程

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

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