0

0

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

P粉602998670

P粉602998670

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

|

881人浏览过

|

来源于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-springmvcspringfox-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.x3.0.x 对应 2.0.x
  • 默认文档地址是 /v3/api-docs(不是 /v2/api-docs),UI 入口是 /swagger-ui.html(注意后缀是 .html,不是 /swagger-ui/)

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

@EnableSwagger2Docket 属于已淘汰的 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 标准字段。

HaloTool
HaloTool

AI工具在线集合网站

下载

立即学习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工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

147

2025.08.06

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

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

85

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

138

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

406

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

73

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

135

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

247

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

31

2026.02.11

Golang 测试体系与代码质量保障:工程级可靠性建设
Golang 测试体系与代码质量保障:工程级可靠性建设

Go语言测试体系与代码质量保障聚焦于构建工程级可靠性系统。本专题深入解析Go的测试工具链(如go test)、单元测试、集成测试及端到端测试实践,结合代码覆盖率分析、静态代码扫描(如go vet)和动态分析工具,建立全链路质量监控机制。通过自动化测试框架、持续集成(CI)流水线配置及代码审查规范,实现测试用例管理、缺陷追踪与质量门禁控制,确保代码健壮性与可维护性,为高可靠性工程系统提供质量保障。

24

2026.02.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4万人学习

C# 教程
C# 教程

共94课时 | 10.4万人学习

Java 教程
Java 教程

共578课时 | 74.7万人学习

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

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