Java整合Swagger教程:快速搭建API文档环境
本文详细介绍了在Java Spring Boot项目中快速集成Swagger3(即SpringDoc OpenAPI)的完整实践:从引入正确的Maven依赖(如springdoc-openapi-starter-webmvc-ui)、通过application.yml灵活配置扫描包路径与UI访问地址,到使用@Tag、@Operation等注解精准描述和分组API,再到多环境分组、接口隐藏及Spring Security放行等关键细节,全程零配置启动、无需@EnableSwagger2,让开发者几分钟内即可拥有自动生成、实时可调、界面友好的在线API文档——告别手写文档与调试工具切换之苦,真正实现“写好接口,文档自来”。

在Java项目中集成Swagger,主要是为了让API接口自动生成文档并提供在线调试界面。核心是引入Swagger依赖、配置扫描路径和启用相关功能,Spring Boot项目通常用Swagger3(即SpringDoc OpenAPI),它不再依赖Swagger2的注解体系,也无需单独启动Swagger UI服务。
添加Maven依赖
使用SpringDoc OpenAPI替代旧版Swagger2,推荐最新稳定版。在pom.xml中加入:
- springdoc-openapi-starter-webmvc-ui:整合OpenAPI规范 + WebMvc + 自带UI
示例依赖(以Spring Boot 3.x为例):
org.springdoc springdoc-openapi-starter-webmvc-ui 2.3.0
若用Spring Boot 2.x,可选springdoc-openapi-webmvc-core + springdoc-openapi-ui组合,版本注意匹配。
基础配置(application.yml)
默认情况下,SpringDoc已自动配置好基础功能。如需自定义,可在application.yml中设置:
- server.servlet.context-path:若项目有上下文路径,Swagger UI地址会自动适配
- springdoc.api-docs.path:修改OpenAPI JSON路径,如
/v3/api-docs - springdoc.swagger-ui.path:修改UI访问路径,如
/swagger-ui.html - springdoc.packages-to-scan:指定要扫描的Controller包(不填则全扫,建议明确指定)
常见配置示例:
springdoc:
packages-to-scan: com.example.demo.controller
api-docs:
path: /api-docs
swagger-ui:
path: /swagger-ui
doc-expansion: none
控制接口可见性与分组
多个模块或环境可能需要区分API展示范围:
- 用
@Tag标注Controller,归类接口 - 用
@Operation描述单个接口功能 - 通过
@Hidden隐藏不需要暴露的接口 - 多分组场景下,定义多个
GroupedOpenApiBean,按路径或包隔离
例如定义“用户组”和“订单组”,只需创建两个GroupedOpenApi bean,分别设置pathsToMatch或packagesToScan即可。
验证与访问
启动项目后,直接访问:
- Swagger UI页面:http://localhost:8080/swagger-ui(路径按配置为准)
- OpenAPI JSON文档:http://localhost:8080/api-docs
确保Controller类上有@RestController或@Controller,方法有明确的HTTP映射(如@GetMapping),且未被@Hidden标记,接口就会自动出现在UI中。
基本上就这些。不需要额外写配置类,也不用@EnableSwagger2注解——SpringDoc是零配置启动,重点在于依赖对、包扫描准、路径没被拦截(比如Spring Security需放行/swagger-ui/**和/v3/api-docs/**)。
以上就是本文的全部内容了,是否有顺利帮助你解决问题?若是能给你带来学习上的帮助,请大家多多支持golang学习网!更多关于文章的相关知识,也可关注golang学习网公众号。
CSS多行截断技巧:-webkit-line-clamp使用方法
- 上一篇
- CSS多行截断技巧:-webkit-line-clamp使用方法
- 下一篇
- DOM扁平化技巧:减少嵌套提升性能
-
- 文章 · java教程 | 13小时前 |
- Java Formatter 怎样控制十六进制输出的宽度和补零
- 492浏览 收藏
-
- 文章 · java教程 | 13小时前 | 并发编程 · Java教程 · java 锁竞争 reentrantlock hasQueuedThreads 并发监控
- Java ReentrantLock.hasQueuedThreads 怎样判断是否有线程排队
- 490浏览 收藏
-
- 文章 · java教程 | 13小时前 | 文件读取 · Stream · Java教程 · java 大文件 Stream try-with-resources Files.lines UncheckedIOException
- Java Files.lines 怎样遍历大文件并确保流关闭
- 305浏览 收藏
-
- 文章 · java教程 | 13小时前 | Java教程 · Optional · java map optional predicate orElseThrow Optional.filter
- Java Optional.filter 按业务条件保留值的链式处理方案
- 234浏览 收藏
-
- 文章 · java教程 | 13小时前 | java Stream linkedhashmap Collectors groupingBy
- Java Stream 怎样按多个字段分组并保留顺序
- 360浏览 收藏
-
- 文章 · java教程 | 13小时前 | 正则表达式 · Java教程 · java 正则表达式 pattern 命名捕获组 Matcher.group
- Java Pattern 命名捕获组怎样按名称读取匹配结果
- 128浏览 收藏
-
- 文章 · java教程 | 13小时前 | unicode · java stringbuilder unicode reverse UTF-16 代理项
- Java StringBuilder.reverse 怎样避免 Unicode 代理项被拆开
- 331浏览 收藏
-
- 文章 · java教程 | 13小时前 | java SequencedCollection reversed 正向遍历 反向视图
- Java SequencedCollection 怎样从同一个集合获取正向和反向视图
- 380浏览 收藏
-
- 文章 · java教程 | 13小时前 |
- Java 模式匹配 switch 怎样处理 null 分支
- 487浏览 收藏
-
- 文章 · java教程 | 13小时前 | java 变量作用域 instanceof 类型收窄 record pattern 模式变量
- Java record pattern 与 instanceof 的变量作用域和类型收窄方法
- 310浏览 收藏
-
- 文章 · java教程 | 13小时前 | 虚拟线程 · java threadlocal 阻塞IO 虚拟线程 Virtual Thread
- Java 虚拟线程怎样判断阻塞调用是否适合迁移
- 133浏览 收藏
-
- 文章 · java教程 | 13小时前 |
- Java Collections.checkedList 怎样让错误类型尽早暴露
- 439浏览 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1069次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1066次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1233次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1176次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1017次使用
-
- 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浏览

