需添加springdoc-openapi-starter-webmvc-ui依赖并配置@tag、@operation等注解:先在pom.xml中引入≥2.0.0版本依赖;再为controller加@tag指定中文分组;接着为每个接口方法添加@operation摘要、@parameter参数说明及@apiresponse响应定义;最后访问/swagger-ui/index.html验证。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要在已有Java Spring Boot项目中,不改动业务逻辑的前提下,为Controller接口快速补全Swagger 3(Springdoc OpenAPI)注释,生成可访问的交互式API文档页面。
确认项目已集成Springdoc OpenAPI依赖
打开项目的 pom.xml,检查是否存在 springdoc-openapi-starter-webmvc-ui 依赖。若缺失,需添加以下内容并保存:
注意:版本号必须 ≥ 2.0.0,低于该版本将无法识别 @Operation 和 @Parameter 等新注解;旧版 springfox 与 springdoc 不兼容,共存会导致启动失败。
为Controller类添加基础API分组信息
在目标 Controller 类上方添加 @Tag 注解,指定中文标签名和简要描述:
@Tag(name = "用户管理", description = "注册、登录、信息查询等用户相关接口")
这一步不能省略——没有 @Tag 的 Controller 在 Swagger UI 中会归入默认的 Default 分组,且不显示中文标题,影响前端查阅体验。
逐个方法补全Swagger注释
对每个 @GetMapping、@PostMapping 等映射方法,按顺序执行以下三步:
第一步:在方法签名上方添加 @Operation,填写 summary(必填)和 description(选填):
@Operation(summary = "根据ID查询用户详情", description = "传入合法用户ID,返回完整用户信息,包含头像URL和注册时间")
Fitten Code 1.0.3是一款由清华博士团队打造的AI编程助手,基于国产计图(Jittor)深度学习框架开发。它支持VS Code、JetBrains系列等主流IDE及80多种编程语言。核心功能包括智能代码补全、注释生成、代码解释、Bug检测、单元测试生成等,旨在全方位提升开发效率。该工具对个人用户免费开放。
第二步:为每个路径变量、请求参数、请求体标注语义化说明:
① 路径变量用 @PathVariable + @Parameter(description = "...") 双重标注;
② 查询参数用 @RequestParam + @Parameter(description = "...");
③ 请求体对象前加 @io.swagger.v3.oas.annotations.media.Schema(description = "..."),并在其字段上使用 @Schema(description = "...")。
第三步:明确声明成功响应体结构与HTTP状态码:
@ApiResponse(responseCode = "200", description = "查询成功", content = @Content(schema = @Schema(implementation = UserVO.class)))
若方法可能抛出全局异常(如 UserNotFoundException),需额外补充对应 @ApiResponse,否则Swagger UI中不会显示该错误码分支。
验证文档是否生效
启动应用,浏览器访问 http://localhost:8080/swagger-ui.html。
如果页面空白或提示 404,请检查是否误用了旧版路径 /swagger-ui.html —— Springdoc 2.x 默认路径是 /swagger-ui/index.html。
若页面加载成功但未显示任何接口,说明至少有一个 Controller 缺少 @Tag 或方法缺少 @Operation,需回溯检查。










