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

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

胖磊大大_3338

胖磊大大_3338

发布时间:2026-06-25 17:57:19

|

508人浏览过

|

来源于php中文网

原创

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<String> 可识别,而 Object 或 Map 则无法准确映射 schema。

热门AI工具

更多
豆包大模型

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

立刻MV
立刻MV Hot

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

DeepSeek

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

VibeKnow
VibeKnow Hot

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

WorkBuddy

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

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

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

616

2026.06.16

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

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

577

2026.06.16

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

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

136

2026.06.16

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

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

670

2026.06.16

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

0

2026.10.16

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

0

2026.10.15

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

0

2026.10.15

Vue.js 中 ref 和 reactive 的区别
Vue.js 中 ref 和 reactive 的区别

Vue.js中ref和reactive的区别专题汇集两种响应式API的定义、访问方式、对象解构、侦听与性能取舍等文章,帮助结合实际状态类型选择合适写法。

0

2026.10.15

VS Code 怎么配置开发环境
VS Code 怎么配置开发环境

VS Code开发环境专题汇集编辑器安装、语言扩展、编译器、解释器、终端和调试配置文章,覆盖Java、Python、C++和PHP等常见语言的入门设置。

0

2026.10.15

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn