CodeGeeX 不原生支持 Swagger 文档自动生成,需结合注解编写、swagger-codegen、Velocity 模板或 swaggo 工具链实现。一、用 CodeGeeX 辅助生成 Swagger 注解代码;二、通过 swagger-codegen 从已注解代码导出 OpenAPI 文档;三、利用 Velocity 模板驱动注解化代码生成;四、在 Go 项目中用 CodeGeeX 补全 swag 注释并执行 swag init。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在使用 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是智谱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 是否成功生成。

















