API文档生成

技能简介

从代码或接口示例自动生成规范、完整、可直接交付的API文档，涵盖字段表、示例、错误码、鉴权说明与版本记录，并支持OpenAPI/Swagger导出及Postman集合生成。

适用：适用于后端开发、技术负责人、开放平台团队在开发、维护或对外发布RESTful API、WebSocket接口、内部微服务接口时，需要快速生成或同步更新API文档的场景。不适用于GraphQL Schema文档、数据库表结构文档或前端组件接口文档的生成。

它能做什么

• 输入收集与范围确认
• 代码注释反向提取
• 字段表结构化整理
• 请求与响应示例编写
• 鉴权方式说明

安装方式

支持平台：WorkBuddy / Claude Code / Codex CLI / Kimi CLI / Cursor / Trae / Goose / OpenClaw / OpenCode