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

Java项目中如何配置Swagger3环境_OpenAPI规范与注解接入

风静君_3959

风静君_3959

发布时间:2026-03-21 16:12:45

|

450人浏览过

|

来源于php中文网

原创

Swagger3与Spring Boot 2.6+集成需彻底清除springfox依赖,仅保留springdoc-openapi-ui;@Operation需配合@Parameter等注解显式声明参数;配置须通过application.yml统一管理,禁用UI需按profile控制并关闭api-docs。

java项目中如何配置swagger3环境_openapi规范与注解接入

Swagger3依赖冲突导致启动失败

Spring Boot 2.6+ 默认启用 SpringDoc,但老项目若残留 springfox-swagger2 或 springfox-swagger-ui,会因 RequestMappingHandlerMapping 冲突直接报错,典型错误是 Failed to start bean 'documentationPluginsBootstrapper'。

必须彻底清理旧 Swagger 依赖:

  • 删掉所有含 io.springfox 的 dependency
  • 确认 pom.xml 中只保留 org.springdoc:springdoc-openapi-ui(推荐 1.7.0+,适配 Spring Boot 2.7/3.x)
  • 若用 Gradle,检查是否意外引入了 springfox 传递依赖,加 exclude group: 'io.springfox'

@Operation 和 @ApiResponse 注解不生效

OpenAPI 3 注解默认不扫描 Controller 方法参数,光写 @Operation 没用;必须配合 @Parameter 显式声明路径、查询、请求体参数,否则文档里看不到入参结构或示例。

常见遗漏点:

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

  • @RequestBody 参数需加 @io.swagger.v3.oas.annotations.media.Content + @Schema 才能生成模型定义
  • @PathVariable 和 @RequestParam 必须用 @Parameter(description = "...") 包裹,不能只靠 Javadoc
  • 返回值类型若为泛型(如 Result<User>),需在 @ApiResponse 中用 implementation = User.class 指定实际类型

示例:正确标注一个带分页查询的接口

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
@GetMapping("/users")
@Operation(summary = "获取用户列表")
public Result<Page<User>> list(
    @Parameter(description = "页码", required = true) @RequestParam Integer page,
    @Parameter(description = "每页数量", required = true) @RequestParam Integer size) {
    // ...
}

配置类中 enable 设置被忽略

springdoc.api-docs.enabled=false 或 @Bean 配置里调用 setUseDoubleSlash(true) 等方法无效,大概率是因为没禁用默认配置自动装配——SpringDoc 会跳过你的 @Configuration 类,直接走 starter 的 SpringDocConfiguration。

解决方式只有两个:

  • 在 application.yml 里统一配,比如:
    springdoc:<br>  api-docs:<br>    enabled: true<br>  swagger-ui:<br>    path: /swagger-ui.html
  • 如果非要 Java 配置,必须加 @Primary 并确保类名不是 SpringDocConfiguration(避免重名覆盖)
  • 注意:Spring Boot 3.x 要求 springdoc.show-actuator=true 才能在 /actuator/openapi 吐出 JSON,否则 404

生产环境暴露 Swagger UI 的风险与开关逻辑

Swagger UI 默认在所有 profile 下都可用,但 /swagger-ui.html 页面一旦上线,等于把接口契约、参数规则甚至示例值全公开,容易被爬取或误用。

安全做法是按 profile 控制:

  • 开发/测试环境用 spring.profiles.active=dev,并配 springdoc.swagger-ui.enabled=true
  • 生产环境必须设 springdoc.swagger-ui.enabled=false,且建议在启动时加 JVM 参数 -Dspringdoc.swagger-ui.enabled=false 防覆盖
  • 即使关闭 UI,/v3/api-docs JSON 仍存在,如需彻底隐藏,得同时设 springdoc.api-docs.enabled=false

别指望靠拦截器或 WebSecurity 忽略 swagger 路径来“伪装”关闭——JSON 接口本身没权限校验,只要路径可访问,文档就泄露。

热门AI工具

更多
VibeKnow
VibeKnow Hot

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

讯飞绘文

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

DeepSeek

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

豆包大模型

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

更多
java
java

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

10877

2023.06.15

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

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

8002

2023.07.05

java自学难吗
java自学难吗

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

6932

2023.07.31

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

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

1164

2023.08.01

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

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

948

2023.08.02

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

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

1416

2023.08.02

java有什么用
java有什么用

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

2869

2023.08.02

java在线网站
java在线网站

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

20151

2023.08.03

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

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

精品课程

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