CodeBuddy可自动为Spring Boot和Node.js项目生成OpenAPI 3.0规范的Swagger文档：通过注解识别、CLI导出、YAML配置、JSDoc扫描及AI补全五种方式，覆盖元信息提取、格式输出、集中配置、框架适配与智能增强全流程。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您在开发Spring Boot或Node.js项目时希望减少手动编写API文档的工作量，CodeBuddy可通过语义分析与注解识别，自动提取接口路径、参数、响应结构等元信息，并生成符合OpenAPI 3.0规范的交互式Swagger文档。以下是具体实现方式：
一、基于Spring Boot注解自动扫描生成
CodeBuddy能深度解析Spring Boot项目中Controller类上的标准Swagger注解（如@ApiOperation、@ApiResponse），在编译期或运行时构建接口元数据模型，并渲染为HTML格式文档页面。
1、确保项目已引入springfox-swagger2或springdoc-openapi-ui依赖，且版本与CodeBuddy兼容。
2、在Controller方法上添加@ApiParam注解标注每个@RequestParam或@RequestBody参数的业务含义与约束条件。
3、使用@ApiResponse注解声明HTTP状态码对应的成功/失败响应体结构，例如@ApiResponse(responseCode = "200", description = "返回用户基本信息")。
4、启动应用后访问http://localhost:8080/swagger-ui.html，即可查看CodeBuddy自动注入增强后的Swagger UI界面。
二、通过CodeBuddy CLI命令行一键导出
CodeBuddy CLI提供专用于文档生成的子命令，支持从源码根目录出发，递归分析Java或JavaScript文件，输出标准化openapi.json并同步部署至本地服务。
1、在项目根目录执行命令：codebuddy doc generate --format openapi3 --output ./docs/openapi.json。
2、确认控制台输出“OpenAPI spec generated successfully”提示，检查./docs/openapi.json是否包含全部接口定义。
3、启动内置文档服务：codebuddy --serve --port 8080 --session-id my-docs。
4、浏览器打开http://127.0.0.1:8080/api/docs，进入交互式Swagger UI测试环境。
三、结合YAML配置文件统一管理文档元数据
CodeBuddy支持将API文档的全局信息（如服务标题、版本号、联系人）从代码中解耦，通过外部YAML文件集中维护，避免硬编码污染业务逻辑，同时便于多环境差异化发布。
1、在resources目录下创建codebuddy-doc.yaml文件。
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手，支持自然语言驱动开发。 - 必备触发词：CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景：安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
2、写入以下字段：title: "订单中心API"、version: "v3.1.0"、contact.email: "api-support@company.com"。
3、在application.properties中添加codebuddy.doc.config-location=classpath:codebuddy-doc.yaml启用配置加载。
四、利用JSDoc扫描生成Node.js接口文档
针对Express等Node.js框架，CodeBuddy可识别符合TSDoc规范的JSDoc注释，自动映射为OpenAPI路径项与参数定义，无需额外引入Swagger专用装饰器。
1、在路由处理函数上方添加完整JSDoc块，包含@param {string} userId - 用户唯一标识和@returns {200} - 返回用户基础信息对象等描述。
2、确保注释中使用@openapi: { tags: ["user"], summary: "获取用户详情" }扩展字段以补充OpenAPI特有元数据。
3、运行CodeBuddy文档扫描指令：codebuddy doc scan --framework express --source ./routes/user.js。
4、生成结果自动合并进项目主OpenAPI文档，支持与Swagger UI无缝集成。
五、AI补全缺失文档字段
当代码中存在未标注参数、无明确响应结构或缺少错误码说明时，CodeBuddy可基于上下文语义推理，智能补全OpenAPI所需的description、schema、example等字段，显著提升文档完整性。
1、选中未注释的REST接口方法，右键选择“AI Generate API Docs”。
2、CodeBuddy自动分析请求体JSON结构、数据库实体映射关系及异常抛出位置，推断出可能的400/404/500响应场景。
3、生成的补全文档片段包含schema引用路径、真实业务示例值及参数校验规则说明。
4、补全内容可直接插入JSDoc或Swagger注解中，支持一键覆盖或差异比对模式。
