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

CodeGeeX如何生成Swagger_CodeGeeX接口文档自动生成【Swagger】

云磊同学_8126

云磊同学_8126

发布时间:2026-04-15 17:18:02

|

806人浏览过

|

来源于php中文网

原创

CodeGeeX 不原生支持 Swagger 文档自动生成,需结合注解编写、swagger-codegen、Velocity 模板或 swaggo 工具链实现。一、用 CodeGeeX 辅助生成 Swagger 注解代码;二、通过 swagger-codegen 从已注解代码导出 OpenAPI 文档;三、利用 Velocity 模板驱动注解化代码生成;四、在 Go 项目中用 CodeGeeX 补全 swag 注释并执行 swag init。

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

codegeex如何生成swagger_codegeex接口文档自动生成【swagger】

如果您在使用 CodeGeeX 进行 Java 项目开发时,希望自动生成符合 Swagger 规范的接口文档,但未见自动注入注解或文档页面,则可能是由于 CodeGeeX 并不原生集成 Swagger 文档生成能力,需配合 Springfox 或 OpenAPI 注解规范与代码生成策略协同实现。以下是多种可行的实现路径:

一、通过 CodeGeeX 辅助编写 Swagger 注解代码

CodeGeeX 可基于自然语言提示快速生成带 Swagger 注解(如 @Api、@ApiOperation、@ApiModel 等)的 Controller 和 DTO 类代码,为后续 Swagger UI 自动解析提供结构化元数据基础。

1、在 IDEA 中选中目标 Controller 类或方法,右键选择 Ask CodeGeeX 或使用快捷键唤出对话框。

2、输入提示语:“为以下 Spring Boot REST 接口添加完整的 Swagger2 注解,包括类级@Api、方法级@ApiOperation、参数级@ApiParam、返回实体级@ApiModel和@ApiModelProperty”。

3、粘贴原始接口代码后提交请求,接收并校验生成的带注解代码。

4、将生成代码覆盖原文件,确保所有字段注释已填写(@ApiModelProperty 的 value 值依赖数据库或字段注释)。

二、结合 swagger-codegen CLI 从 CodeGeeX 生成的 API 代码反向导出 OpenAPI 文档

当 CodeGeeX 已生成含标准 REST 接口定义的 Java 服务端代码(如 Spring Boot + @RestController),可借助 swagger-codegen 的静态分析能力,从源码提取接口信息并生成 swagger.json 或 openapi.yaml。

1、确保项目中已存在正确配置的 springfox-swagger2 与 springfox-swagger-ui 依赖(2.9.2 或更高兼容版本)。

2、启动应用后访问 http://localhost:8080/v2/api-docs,确认返回标准 JSON 格式接口描述。

3、执行命令将 JSON 导出为 HTML 文档:
java -jar swagger-codegen-cli.jar generate -i http://localhost:8080/v2/api-docs -l html -o ./docs/swagger-html

4、打开 ./docs/swagger-html/index.html 即可查看离线渲染的 Swagger UI 页面。

CodeGeex 2.21.0
CodeGeex 2.21.0

CodeGeeX 2.21.0是智谱AI推出的AI编程助手版本,对Inline Chat功能进行了重大优化,包括UI设计升级、支持流式输出以提升响应速度,并新增“查看思路”按钮以便理解代码原理。同时,该版本在编辑器中新增CodeLens控件,支持一键“解释”代码或“添加注释”。目前该工具对个人开发者免费开放。

下载

三、利用 CodeGeeX 模板生成器对接 Velocity + Swagger 注释驱动代码生成流程

该方法复用 CodeGeeX 的模板代码生成能力,将数据库表结构、字段注释与 Swagger 注解逻辑封装进 Velocity 模板,实现“建表即生成可文档化接口代码”。

1、在 CodeGeeX 插件中新建 code-generator 项目,并引入 velocity-engine-core 与 springfox-swagger2 依赖。

2、编写 Velocity 模板(如 controller.vm),在方法体中插入 @ApiOperation(value = "${column.comment}") 等动态注解语句。

3、运行 CodeGeeX 提供的代码生成脚本,输入表名,自动输出含完整 Swagger 注解的 Controller、DTO、Service 层代码。

4、确保数据库字段已添加 COMMENT,否则生成的 @ApiModelProperty.value 将为空字符串。

四、在 Gin/Go 项目中通过 CodeGeeX 快速补全 swag 注释并触发 docs 生成

针对 Go 技术栈,CodeGeeX 可精准识别 swaggo/swag 规范语法,在 handler 函数前补全 @Summary、@Description、@Param、@Success 等注释,从而支持 swag init 自动生成 docs/doc.go 与 Swagger UI 所需资源。

1、在 Go 文件中光标定位至 HTTP 处理函数上方空白行。

2、调用 CodeGeeX 的 Generate Comment 功能,选择 Swag Comment 模式。

3、确认生成的注释包含 @ID、@Tags、@Accept、@Produce、@Success 等必要字段,且状态码与结构体类型匹配。

4、终端执行 swag init -g main.go -o ./docs,检查 ./docs/swagger.json 是否成功生成。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

墨刀AI
墨刀AI Hot

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

豆包大模型

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

立刻MV
立刻MV Hot

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2989

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2248

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1200

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1138

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1336

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2078

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3300

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

14755

2023.09.22

C++运算符基础入门
C++运算符基础入门

本专题详细讲解了C++运算符的类型、语法与使用方法,涵盖算术运算符、关系运算符、逻辑运算符、位运算符、赋值运算符、条件运算符及其他特殊运算符,并通过代码示例解析优先级与结合性。

0

2026.10.09

热门下载

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

精品课程

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

共0课时 | 0人学习

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

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