codebuddy生成swagger文档需四步：明确http动词、路径、请求响应结构并标注类型约束；强制yaml格式与字段补全规则；设temperature=0.1；提取纯yaml内容。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你想让CodeBuddy生成一份结构清晰、字段准确、能直接用于Swagger UI渲染的API文档，但每次输出都缺参数类型、漏状态码说明或嵌套对象展开不全，问题往往出在提示词没踩中模型理解的关键锚点。
用自然语言直生成OpenAPI文档
这方法适合接口设计先行阶段，比如原型评审时需要快速交付契约文档，不依赖已有代码。
第一步：明确写出HTTP动词、完整路径、请求体结构和响应示例，每个字段必须带类型与约束。例如：“POST /api/v1/orders，请求体含items（数组，每项含sku:string、quantity:integer≥1）、customerEmail:string格式校验，响应201返回{“orderId”: “string”, “createdAt”: “string”, “items”: [ { “sku”: “string”, “quantity”: 1 } ] }”。
第二步：强制指定输出格式与字段补全规则。输入提示词时追加：“生成符合OpenAPI 3.0规范的YAML，要求requestBody.content.application/json.schema所有字段标注type、example、description；responses.201.content.application/json.schema中嵌套数组需展开至二级；禁止省略required字段声明。”
第三步：调用时设置低随机性。在CodeBuddy IDE中提交该提示词后，【务必在高级选项中将temperature设为0.1】，否则模型可能自由发挥，导致schema缺失或枚举值错位。
第四步：提取纯YAML内容。接收返回后，只保留```yaml与```之间的文本，删掉前后所有解释性语句——任何多余字符都会导致Swagger Editor校验失败。
基于源码注释生成Markdown文档
当你已有Controller代码，想从JSDoc自动拉出可读性强的团队文档，这条路径最稳。
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 问题
方法一：在Express路由函数上方写标准JSDoc，必须包含@openapi标签及method、path、summary。例如：/** @openapi { post } /api/v1/users summary: 创建用户 parameters: [{name: "body", in: "body", required: true, schema: { $ref: "#/components/schemas/UserCreate" }}] responses: { 201: { description: "创建成功", schema: { $ref: "#/components/schemas/UserResponse" } } } */
方法二：确保项目根目录有swaggerOptions配置，其中apis字段精确指向含注释的文件路径，如./src/routes/*.ts。路径写错会导致CodeBuddy扫描不到任何注释。
方法三：右键选中目标方法→“CodeBuddy → Generate API Doc”，输出路径选docs/api/。这一步操作起来很简单，直接把文件拖进去就行。
用CLI指令批量生成项目级文档
适用于已跑通本地开发环境、需一次性输出整套后端接口说明的场景。
执行codebuddy doc --scope api --output docs/api-overview.md命令前，先确认项目根目录存在routes/子目录且含至少两个Controller文件——【若目录为空或命名不规范（如叫controllers而非routes），CLI将静默跳过扫描】。
等待终端打印“✅ Generated 7 endpoints documentation”后，打开生成的md文件，检查是否自动提取了@ApiResponse注解中的status、description，并为每个query参数生成了表格化说明。
如果发现参数未被识别，回到对应Java或TypeScript文件，在@RequestParam或@Query装饰器旁补一行JSDoc，例如“@param {string} page - 页码，从1开始计数”。
大量免费API接口：立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游，为数据API应用能力赋能！
