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

如何在Java中配置Swagger文档生成环境_Java接口文档解析

阿静小哥_7105

阿静小哥_7105

发布时间:2026-03-01 12:16:58

|

1041人浏览过

|

来源于php中文网

原创

springdoc-openapi 是当前唯一靠谱选择,因旧版已停更且与 Spring Boot 2.6+ 冲突,而它基于 OpenAPI 3、无需 WebMvcConfigurer、天然兼容新版本。

如何在java中配置swagger文档生成环境_java接口文档解析

Swagger 在 Java 项目里不是“配好就能用”,而是“不踩坑才真能用”——Spring Boot 2.6+ 默认禁用 WebMvcConfigurer 的自动配置,Swagger2 直接失效;springdoc-openapi 成为事实标准,但版本选错或路径冲突照样 404。

为什么 springdoc-openapi 是当前唯一靠谱选择

旧版 swagger-springmvc 和 springfox-swagger2 已停止维护,且与 Spring Boot 2.6+ 的 spring.mvc.pathmatch.matching-strategy=ant_path_matcher 冲突,启动报 NoHandlerFoundException。Spring 官方推荐的 springdoc-openapi 基于 OpenAPI 3,无需额外配置 WebMvcConfigurer,天然兼容新版本。

  • 必须用 springdoc-openapi-ui(非 springdoc-openapi-webmvc-core 单独引入),否则 UI 页面 404
  • Maven 依赖要和 Spring Boot 版本对齐:spring-boot-starter-parent 2.7.x 对应 springdoc-openapi-ui 1.6.x;3.0.x 对应 2.0.x
  • 默认文档地址是 /v3/api-docs(不是 /v2/api-docs),UI 入口是 /swagger-ui.html(注意后缀是 .html,不是 /swagger-ui/)

配置类写法:别碰 @EnableSwagger2,也别手动注册 Docket

@EnableSwagger2 和 Docket 属于已淘汰的 springfox 体系,混用会导致 Bean 冲突、Swagger UI 加载空白。新版全部靠配置项驱动,零 Java 配置也能跑起来。

  • 最简启动:只加依赖,不写任何配置类,访问 /swagger-ui.html 就能看到基础文档
  • 如需自定义标题、描述、版本,用 application.yml:
springdoc:
  api-docs:
    path: /api-docs
  swagger-ui:
    path: /swagger-ui.html
    doc-expansion: none
    tags-sorter: alpha
info:
  title: 订单服务 API
  version: 1.0.0
  description: 支付与履约相关接口
  • 切勿在配置类里 return new Docket(...) 或 @Bean Docket —— 这是过期范式,会覆盖 springdoc 自动装配

接口注解怎么写才生效:重点不是 @Api,而是 @Operation 和 @Parameter

旧注解 @Api、@ApiOperation 来自 swagger-annotations,虽仍可用,但推荐统一用 io.swagger.v3.oas.annotations 下的新注解,语义更清晰、支持 OpenAPI 3 标准字段。

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载

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

  • 类级说明用 @Tag(name = "OrderController", description = "订单操作")
  • 方法级必须加 @Operation(summary = "创建订单", description = "返回订单 ID 和支付链接")
  • 路径参数用 @Parameter(description = "订单 ID", required = true) 注在 @PathVariable 参数上
  • 请求体对象不用额外注解,只要字段有 @Schema(description = "用户手机号") 就能透出到文档
  • 忽略某个接口?加 @Hidden,比 @ApiIgnore 更可靠

生产环境关闭 Swagger:别只删依赖,得关掉资源加载

仅在 application-prod.yml 里删掉 springdoc 配置项不够——静态资源(/swagger-ui.html、/webjars/)仍可被直接访问,存在信息泄露风险。

  • 必须加配置彻底禁用:
springdoc:
  api-docs:
    enabled: false
  swagger-ui:
    enabled: false
  • 更稳妥做法:用 profile 控制依赖,Maven 中将 springdoc-openapi-ui scope 设为 runtime,并在 prod profile 中 exclude 它
  • 注意:Spring Security 若未放行 /v3/api-docs/** 和 /swagger-ui.html,开发环境也会 403 —— 不是 Swagger 挂了,是权限拦住了

真正麻烦的从来不是加几行配置,而是旧项目里残留的 springfox 依赖、混用的注解包、以及没意识到 /v3/api-docs 和 /v2/api-docs 是两个世界。

热门AI工具

更多
二狗PPT
二狗PPT Hot

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

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

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

豆包大模型

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

WorkBuddy

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

蛙蛙写作

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

相关专题

更多
java
java

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

12057

2023.06.15

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

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

9162

2023.07.05

java自学难吗
java自学难吗

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

7832

2023.07.31

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

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

1284

2023.08.01

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

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

1028

2023.08.02

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

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

1516

2023.08.02

java有什么用
java有什么用

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

3149

2023.08.02

java在线网站
java在线网站

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

20411

2023.08.03

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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