可利用claude通过四种路径快速生成标准化swagger文档:一、用claude code router调用本地qwen3.5模型解析代码输出openapi schema;二、vs code插件结合结构化提示词自动生成yaml片段;三、clawhub技能包扫描旧项目注释并语义补全为swagger.json;四、web界面粘贴代码+指定模板输出markdown+yaml。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您已有接口代码但缺乏标准化的 Swagger 文档,则可能是由于手动编写耗时、格式易错或与实际逻辑脱节。以下是利用 Claude 快速生成 Swagger 接口文档的多种可行路径:
一、通过 Claude Code Router 调用本地模型解析代码并输出 OpenAPI Schema
该方法利用 Claude Code Router 作为中间代理,将控制器代码和实体类输入至本地部署的 Qwen3.5-4B-Claude 模型,由其结构化识别路由、参数、响应体并生成符合 OpenAPI 3.0 规范的 YAML 或 JSON 文档。
1、确保已启动 Claude Code Router 服务,端口为 3456,默认配置中已启用 xingtu-local 提供商。
2、准备待文档化的代码文件,例如 Express 控制器文件 users.controller.ts 和请求/响应 DTO 类 user.dto.ts。
3、执行命令:claude -p "基于以下 TypeScript 代码生成 OpenAPI 3.0 YAML 格式文档,包含 /api/v1/users GET 和 POST 路径,标注所有参数类型、状态码及示例响应。"
4、将输出内容保存为 openapi.yaml,并使用 Swagger UI 本地加载验证。
二、使用 VS Code 插件 + 结构化提示词触发自动文档生成
该方法依赖 VS Code 中已安装的 Claude Code 插件,结合明确层级指令,驱动模型从当前打开的控制器文件中提取接口元信息,并按 Swagger 所需字段映射生成注释块或独立 YAML 文件。
1、在 VS Code 中打开目标控制器文件,确保光标位于导出的路由处理函数上方。
2、按下快捷键 Ctrl+Shift+P,输入 “Claude: Generate Documentation”,选择 “Swagger API Spec (OpenAPI 3.0)” 模板。
3、在弹出的提示框中输入:请根据此函数签名和 JSDoc 注释,生成完整的 paths 对象片段,要求包含 summary、description、parameters、requestBody(若存在)、responses 及各 status code 示例值。
4、确认生成后,插件将自动在同目录下创建 swagger-paths.generated.yaml 并高亮差异行。
三、借助 ClawHub 的 markdown-generator 技能包批量提取并渲染
该方法适用于已完成 Swagger 注释(如 @api、@apiParam)的旧项目,通过 ClawHub 技能包扫描代码库中的注释标记,调用 Claude 模型进行语义补全与格式转换,最终输出可直接集成进 Swagger UI 的静态 JSON 文档。
1、运行 clawhub install markdown-generator 安装技能包,确保 ~/.openclaw/openclaw.json 中已配置 xingtu-local 模型端点。
2、进入项目根目录,执行 clawhub run markdown-generator --input ./src/controllers --output ./docs/swagger.json --format openapi3
3、技能包自动识别所有含 @api 标签的 JS/TS 文件,将每个接口的 @apiParam、@apiSuccess 等字段映射为 OpenAPI components.schemas 条目。
4、生成的 swagger.json 中,所有 400/401/404 响应均被自动补全 error schema 定义,且 status code 示例值与真实中间件抛出错误一致。
四、粘贴核心代码至 Claude Web 界面并指定输出模板
该方法适合无本地环境、仅需单次快速产出的场景,通过精确限定输出结构,规避自由生成导致的格式偏差,确保结果可直接用于 Swagger Editor 导入。
1、复制控制器中完整路由定义代码段(含 express.Router().get/post 及 handler 函数体)和对应 DTO 类定义。
2、在 Claude 官方 Web 界面新建对话,输入提示词:“你是一名 API 文档工程师。请严格按以下结构输出 Markdown 表格+YAML 块:第一部分为接口摘要表格(列:路径、方法、摘要、认证方式);第二部分为完整 OpenAPI 3.0 YAML,仅包含 paths 和 components.schemas,不包含 info/server 字段。”
3、粘贴代码后发送,等待模型返回结构化内容。
4、将 YAML 块复制进 https://editor.swagger.io 左侧编辑区,右侧即实时渲染交互式文档。











