Java整合Swagger生成API文档教程
2026-02-26 16:40:40
0浏览
收藏
Java项目集成Swagger可自动生成清晰、交互式的API文档,大幅提升开发协作效率与接口维护质量;本文详解了Spring Boot 2.x下使用Springfox(需配置@EnableSwagger2和Docket)与Spring Boot 3+推荐的SpringDoc(零配置、开箱即用)两大主流方案,涵盖依赖引入、访问路径(如/swagger-ui/index.html)、接口注解(@Tag/@Operation/@Parameter等)增强文档可读性,以及生产环境安全关闭、JWT认证集成和中文支持等关键实践,助你快速落地专业级API文档体系。

Java项目中集成Swagger可以快速实现API文档的自动生成,提升开发效率,减少手动编写文档的工作量。目前主流使用的是Spring Boot项目结合Swagger(通常使用Springfox或SpringDoc)来自动生成接口文档。
1. 使用Springfox集成Swagger
Springfox是较早流行的Swagger集成工具,适用于Spring Boot 2.x版本。
步骤如下:- 添加Maven依赖:在
pom.xml中引入Springfox Swagger依赖:
io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2
- 配置Swagger:创建一个配置类启用Swagger:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("项目API文档")
.description("基于Swagger生成的RESTful API文档")
.version("1.0")
.build();
}
}
- 启动项目后访问:
浏览器打开 http://localhost:8080/swagger-ui.html 即可查看自动生成的API文档。
2. 使用SpringDoc替代Springfox(推荐用于Spring Boot 3+)
Spring Boot 3以后不再兼容Springfox,推荐使用SpringDoc OpenAPI,它支持OpenAPI 3规范,且无需额外配置即可自动集成。
- 添加SpringDoc依赖:
org.springdoc springdoc-openapi-starter-webmvc-ui 2.0.2
- 无需额外配置类,SpringDoc会自动扫描所有Controller并生成文档。
- 访问地址:
启动项目后访问 http://localhost:8080/swagger-ui.html 或 http://localhost:8080/swagger-ui/index.html 查看UI界面。
3. 添加接口注解丰富文档内容
通过在Controller和方法上添加Swagger注解,可以让文档更清晰。
@Tag(name = "用户模块"):给Controller分类@Operation(summary = "获取用户信息", description = "根据ID查询用户"):描述接口功能@Parameter(description = "用户ID", required = true):描述参数@ApiResponse:定义响应状态码和说明
示例:
@RestController
@Tag(name = "用户管理")
public class UserController {
@GetMapping("/user/{id}")
@Operation(summary = "获取用户详情")
public ResponseEntity getUserById(
@Parameter(description = "用户ID", required = true)
@PathVariable Long id) {
// 业务逻辑
return ResponseEntity.ok(new User(id, "张三"));
}
}
4. 注意事项与优化建议
- 生产环境建议关闭Swagger,可通过配置控制:
springdoc: api-docs: enabled: false swagger-ui: enabled: false并在开发 profile 中开启。 - 支持JWT等安全认证的展示,在配置中加入SecurityScheme即可。
- 支持中文文档,确保项目编码为UTF-8,注解内容可直接写中文。
基本上就这些。选择Springfox还是SpringDoc取决于你的Spring Boot版本。新项目建议直接使用SpringDoc,更轻量、兼容性更好,集成也更简单。
文中关于的知识介绍,希望对你的学习有所帮助!若是受益匪浅,那就动动鼠标收藏这篇《Java整合Swagger生成API文档教程》文章吧,也可关注golang学习网公众号了解相关技术文章。
Golang切片清空不释放内存技巧
- 上一篇
- Golang切片清空不释放内存技巧
- 下一篇
- 有道智云入口在哪?AI翻译直达链接
查看更多
最新文章
-
- 文章 · java教程 | 11小时前 | nio · Java教程 · 文件系统 · java FileStore supportsFileAttributeView 文件属性视图
- Java FileStore.supportsFileAttributeView 怎样判断存储卷支持哪些文件属性视图
- 176浏览 收藏
-
- 文章 · java教程 | 11小时前 | Java · 日期时间 · java locale LocalDate WeekFields weekOfMonth DayOfWeek
- Java WeekFields.weekOfMonth 怎样按地区规则计算月份中的周数
- 274浏览 收藏
-
- 文章 · java教程 | 12小时前 | Java · java MethodType lastParameterType
- Java MethodType.lastParameterType 怎样读取方法类型的最后一个参数
- 267浏览 收藏
-
- 文章 · java教程 | 13小时前 | 反射 · 迁移 · Java教程 · java 方法句柄 MethodHandle MethodType MethodHandles.empty
- Java MethodHandles.empty 怎样构造接受参数但不执行操作的方法句柄
- 387浏览 收藏
-
- 文章 · java教程 | 14小时前 |
- Java MethodHandles.arrayConstructor 怎样构造指定类型的数组创建句柄
- 296浏览 收藏
-
- 文章 · java教程 | 14小时前 | Java · 字符集 · java 字符集编码 CharsetEncoder isLegalReplacement 替代字节
- Java CharsetEncoder.isLegalReplacement 怎样检查替代字节序列能否被编码器接受
- 365浏览 收藏
-
- 文章 · java教程 | 15小时前 | Java · nio · java FileStore getBlockSize 文件系统块大小
- Java FileStore.getBlockSize 怎样查询文件系统块大小
- 428浏览 收藏
-
- 文章 · java教程 | 16小时前 | Java教程 · 日期时间 · java LocalDate WeekFields weekBasedYear weekOfWeekBasedYear ISO周
- Java WeekFields.weekBasedYear 怎样读取周所属年份而不是日历年份
- 401浏览 收藏
-
- 文章 · java教程 | 17小时前 | Java教程 · java optional JPMS Mainclass ModuleDescriptor module-info.class
- Java ModuleDescriptor.mainClass 怎样读取模块声明的主类名称
- 109浏览 收藏
-
- 文章 · java教程 | 17小时前 | Java · java ThreadMXBean ThreadInfo isInNative
- Java ThreadInfo.isInNative 怎样判断线程是否在执行本地方法
- 132浏览 收藏
-
- 文章 · java教程 | 18小时前 | 标准库 · Java教程 · java 反射 MethodHandle MethodType parameterArray
- Java MethodType.parameterArray 怎样复制方法类型的参数类型数组
- 397浏览 收藏
-
- 文章 · java教程 | 19小时前 | 标准库 · Java教程 · java 默认值 ZeRO MethodHandles MethodHandle
- Java MethodHandles.zero 怎样生成返回指定类型零值的方法句柄
- 206浏览 收藏
查看更多
课程推荐
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
查看更多
AI推荐
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1102次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1099次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1270次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1211次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1058次使用
查看更多
相关文章
-
- Java 时间格式兼容多个输入格式的方法
- 2026-10-18 501浏览
-
- Java try-with-resources 多个资源关闭顺序是什么
- 2026-09-10 501浏览
-
- 矩阵主副对角线快速定位技巧
- 2026-05-31 501浏览
-
- Java多态优化流程代码与行为分发改进
- 2026-05-26 501浏览
-
- JVM 类元数据双亲委派链表深度解析
- 2026-05-21 501浏览

