CodeGeeX支持为Spring Boot Controller自动生成符合SpringDoc OpenAPI 3规范的注释:单方法在方法上方输入/**回车即可;整类可右键或按Ctrl/Cmd+Shift+D触发;无注释代码也能基于签名生成Markdown文档。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你想在 Spring Boot 项目里为 Controller 方法快速加上标准 OpenAPI 注释,避免手敲 @Operation、@Parameter、@ApiResponse 时漏字段或写错类型,又不想引入过时的 Swagger2 注解——CodeGeeX 能直接生成符合 SpringDoc OpenAPI 3 规范的 JavaDoc 注释块,且能识别 DTO 结构自动展开字段描述。
用 CodeGeeX 自动生成单个方法的 OpenAPI 注释
这一步操作起来很简单,直接在方法上方空行输入 /** 再回车即可触发。
将光标定位到目标 @PostMapping、@GetMapping 等 REST 方法的正上方空白行。
输入 /** 后立即按下 Enter(回车) 键。
CodeGeeX 会自动补全完整 JavaDoc 块,包含 @Operation(含 summary 和 description)、按参数位置自动标注的 @Parameter(path/query/body)、以及预置的 @ApiResponse(200/400/500)。
注意:若方法接收自定义 DTO 对象,CodeGeeX 仅在该 DTO 已成功编译且位于当前 module classpath 中时,才能解析其字段并生成对应 @Parameter 描述;否则一律标记为 object 类型,需手动补充。
批量为整个 Controller 注入 OpenAPI 注释
当你刚新建完 UserController.java,里面十几个接口都还没加文档注释,逐个敲太耗时——这时用批量注入最省力。
方法一:右键菜单触发
将光标置于类名(如 public class UserController)任意位置 → 右键 → 选择「AI 生成 Swagger 注释」→ 等待 2~4 秒 → 自动生成全部接口的 @Tag、@Operation、@Parameter、@ApiResponse,并按业务语义填充中文描述。
方法二:快捷键触发(推荐)
Windows 用户按 Ctrl+Shift+D,Mac 用户按 Cmd+Shift+D,光标必须落在类声明行(如 public class UserController {...})上,不能在方法内部或空行。
生成结果严格遵循 SpringDoc OpenAPI 3 规范,不使用 @Api、@ApiOperation 等 Swagger2 遗留注解,兼容 Spring Boot 3.3+。
从已有代码反向提取 OpenAPI 文档(无注释也能生成)
面对历史遗留项目,Controller 方法既没 JavaDoc 也没任何 Swagger 注解,但你仍需要一份准确文档——CodeGeeX 可基于函数签名和类型推断生成 Markdown 文档片段。
第一步:选中目标方法整段代码(包括 @RequestMapping 行、参数列表、返回类型)。
第二步:右键 → 选择「生成接口文档」,或使用快捷键 Ctrl+Shift+D(Windows/Linux) / Cmd+Shift+D(Mac)。
第三步:CodeGeeX 自动分析请求方式、路径变量、查询参数、@RequestBody 结构、响应状态码及返回类型,输出结构清晰的 Markdown 文档块。
第四步:将生成内容粘贴至项目 docs/api/ 目录下,保存为 users_api.md 或其他语义化文件名。
这一步不要求代码含任何注释,但【参数必须有明确类型声明】,例如 List<String> 可识别,而 Object 或 Map 则无法准确映射 schema。


















