☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
codebuddy需启用自动文档生成功能才能生成符合协作与集成要求的api文档，具体路径包括：一、注释驱动生成markdown；二、引用controller生成结构化文档；三、自动生成openapi 3.0规范；四、配置models.json注入第三方元数据。
如果您使用codebuddy开发后端服务，但尚未生成符合团队协作与第三方集成要求的api文档，则可能是由于未启用其基于代码语义与结构化注解的自动文档生成功能。以下是为codebuddy项目编写标准api接口文档的具体操作路径：
一、通过注释驱动生成Markdown格式文档
CodeBuddy支持解析源码中标准化的注释块（如/** ... */），提取接口路径、请求方式、参数定义及返回结构，并以可读性强的Markdown格式输出为独立文档文件，便于版本管理与协同查阅。
1、在Controller方法上方添加多行JSDoc风格注释，包含@method、@url、@param、@returns等标签；
2、确保每个@param后注明类型、是否必填及业务含义，例如：@param {string} userId - 用户唯一标识，长度为32位UUID字符串；
3、在@return中明确响应体JSON结构，嵌套字段需逐级展开说明；
4、选中该方法所在代码块，在编辑器右键菜单中选择“CodeBuddy → Generate API Doc”；
5、指定输出路径并确认，系统将自动生成以接口名命名的.md文件，含请求示例与响应样例。
二、引用Controller生成结构化API文档
CodeBuddy可通过静态分析控制器类，识别所有被路由映射的方法及其元数据，结合用户提供的API地址、请求方式、参数列表与返回定义，构建完整接口清单，并组织为层级清晰的文档结构。
1、在对话框中输入指令：/generate-api-doc from UserController；
2、粘贴该Controller对应的实际HTTP访问地址，如https://api.example.com/v1/users；
3、确认请求方式（GET/POST/PUT/DELETE）并逐项填写各端点的查询参数、请求体字段及校验规则；
4、为每个接口提供至少一组真实格式的请求参数示例与预期返回JSON；
5、点击生成后，CodeBuddy将输出一个包含目录导航、接口分组、状态码说明的完整Markdown文档。
三、基于代码逻辑自动生成OpenAPI 3.0规范文档
CodeBuddy可深度解析Spring Boot或Express等主流框架的代码结构，识别@Controller/@Route声明、@RequestBody/@RequestParam绑定、异常处理机制及DTO类型定义，从而推导出符合OpenAPI 3.0标准的YAML或JSON描述文件，供Swagger UI或Redoc渲染展示。
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 问题
1、确保项目已启用注解扫描能力，且关键类位于默认扫描包路径下；
2、在项目根目录执行命令：codebuddy doc --format openapi3 --output openapi.yaml；
3、检查生成的openapi.yaml是否包含info、servers、paths、components四大核心节；
4、若存在自定义响应体（如统一Result
5、将生成文件提交至docs目录，即可通过CI流程自动部署至文档站点。
四、配置models.json注入第三方API元数据生成文档
当CodeBuddy需对接外部SaaS服务或遗留系统时，可通过手动维护models.json文件注入接口契约信息，包括路径、鉴权方式、字段映射关系等，使AI能据此生成准确、可用的调用说明与测试用例。
1、定位CodeBuddy安装目录下的models.json文件；
2、在"external_apis"节点下新增对象，包含name、base_url、auth_type（如bearer）、headers等字段；
3、为每个endpoint定义method、path、request_schema（JSON Schema格式）、response_schema；
4、保存文件后，在CodeBuddy对话框中输入：/doc for payment-gateway-api；
5、系统将读取配置并生成含curl示例、字段约束、错误码表的HTML兼容Markdown文档。
大量免费API接口：立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游，为数据API应用能力赋能！
