CodeBuddy支持三种接口文档生成方式：1. 自然语言指令即时生成Markdown文档；2. 基于JSDoc注释自动生成OpenAPI 3.0 YAML；3. 引用Spring Boot Controller类批量生成结构化文档。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要为团队或第三方快速整理出一份结构清晰、字段准确、可直接用于联调的接口文档，但手动逐条录入路径、参数和响应体耗时且容易遗漏关键约束条件。用自然语言指令即时生成Markdown接口文档
适用于已有Controller代码但尚未写注释、或仅凭需求描述就要先产出文档的场景。CodeBuddy能根据你一句话描述，自动补全路径、动词、请求体结构、状态码说明和示例。
在CodeBuddy CLI交互模式下输入：“生成用户登录接口文档：POST /api/v1/auth/login，请求体含email（字符串，必须为有效邮箱格式）、password（字符串，长度6-20位），返回200成功响应{“token”: “string”, “expiresIn”: 3600}，401返回{“error”: “invalid_credentials”}。”
等待AI输出完整Markdown内容，包含标题、请求URL、方法、请求头说明、参数表格、响应状态码列表及两个JSON样例块。
复制全部内容，粘贴至项目根目录下的docs/api-login.md中保存。这一步操作起来很简单，直接把文件拖进去就行。
基于JSDoc注释自动生成OpenAPI 3.0 YAML
适合Node.js/Express项目，要求已存在带@openapi标签的JSDoc注释。CodeBuddy会解析这些注释并补全OpenAPI必需字段，避免手写YAML时漏掉components或securityDefinitions。
方法一：CLI命令导出
确保项目中每个路由函数上方都有如下格式注释：
/**
* @openapi
* /api/v1/orders:
* post:
* summary: 创建订单
* requestBody:
* required: true
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/CreateOrderRequest'
*/
在项目根目录执行：codebuddy doc generate --format openapi3 --output openapi.yaml
生成后立即检查openapi.yaml是否包含components.schemas.CreateOrderRequest定义——【若缺失，说明@openapi块未被正确识别，需确认注释缩进与空行是否符合swagger-jsdoc规范】。
方法二：IDE内右键触发
在VS Code中打开含注释的routes/order.js，选中整个@openapi注释块 → 右键 →「CodeBuddy → Export as OpenAPI」→ 选择YAML格式 → 点击导出。
引用现有Controller类批量生成结构化文档
适用于Spring Boot项目，无需逐行写注释，CodeBuddy可通过静态分析自动提取@RequestMapping、@RequestParam、@RequestBody等元信息，并关联DTO类型定义。
第一步：确认项目结构
确保Controller类位于src/main/java/com/example/demo/controller/下，且已启用@ComponentScan或@SpringBootApplication扫描该包路径。
第二步：启动文档生成任务
在CodeBuddy IDE中点击顶部菜单栏「Tools」→「Generate API Docs from Controllers」→ 弹窗中输入：/generate-api-doc from OrderController, UserController
第三步：补充缺失元数据
系统自动填充基础路径与参数名后，需手动在弹窗右侧面板中为每个@RequestParam字段填写“是否必填”和“业务含义”，例如：page → 必填否 → “分页页码，从1开始，默认为1”。
第四步：导出并验证
点击「Export as Markdown」，保存为docs/api-reference.md；打开文件，确认所有接口均含「请求示例」与「响应样例」区块，且字段类型与实际DTO一致。
