如何利用 CodeGeex 快速生成符合 OpenApi 标准的 Swagger 注释

胖磊大大_3338

胖磊大大_3338

2026-06-25

508人浏览

原创

codegeex支持为spring boot controller自动生成符合springdoc openapi 3规范的注释:单方法在方法上方输入/**回车即可;整类可右键或按ctrl/cmd+shift+d触发;无注释代码也能基于签名生成markdown文档。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如何利用 codegeex 快速生成符合 openapi 标准的 swagger 注释

你想在 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,并按业务语义填充中文描述。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

方法二:快捷键触发(推荐)
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 可识别,而 Object 或 Map 则无法准确映射 schema。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

codegeex spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
CodeGeeX下载安装教程合集
CodeGeeX下载安装教程合集

提供CodeGeeX最新版下载地址、历史版本下载、VS Code安装教程、JetBrains安装教程及常见安装问题解决方案。

2026.06.16

616

15

CodeGeeX代码生成教程合集
CodeGeeX代码生成教程合集

汇总CodeGeeX代码生成技巧、代码补全教程、单元测试生成、代码优化及实际开发案例。

2026.06.16

597

31

CodeGeeX大模型教程合集
CodeGeeX大模型教程合集

详细介绍CodeGeeX底层模型能力、多语言代码生成效果、模型架构及应用场景

2026.06.16

136

10

CodeGeeX VSCode插件教程大全
CodeGeeX VSCode插件教程大全

专注CodeGeeX VS Code插件的安装配置、功能使用、快捷键及开发实践。

2026.06.16

670

15

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

0

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

0

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

0

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

0

15

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

2026.10.16

0

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CodeGeex使用手册
CodeGeex使用手册

共0课时 | 0人学习

Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习