用途:在 API 端点新增或修改、路由或控制器文件变更、用户提到 API 文档、OpenAPI 或 Swagger 时自动激活,从代码和注释生成 API 文档。
主要能力:生成 OpenAPI 3.0 规范(JSON/YAML),包含端点描述、请求/响应 schema、认证要求、示例载荷和错误响应;同时支持 Swagger 2.0、API Blueprint、RAML 格式。可自动识别 Express.js、FastAPI、Django REST、Spring Boot、Gin、Rails 框架,解析 JSDoc、Python docstring、JavaDoc 及带装饰器的行内注释。对缺少注释的代码可建议补充文档,并生成贴近真实的请求/响应示例。
使用方式:作为 Skill 在代码变更时自动触发,无需额外配置,不依赖网络,会写入 OpenAPI 文件。生成的规范可接入 Swagger UI、导入 Postman 测试,或用于 Docusaurus、MkDocs、Redoc、Stoplight 等文档站点。可通过复制目录自定义公司文档标准:cp -r ~/.claude/skills/documentation/api-documenter ~/.claude/skills/documentation/company-api-documenter。
适用场景:需要随代码同步维护 API 规范、快速产出可渲染的接口文档、为测试工具提供规范输入。
限制:文档质量依赖代码注释与类型提示的完整度;与 @docs-writer 子智能体分工不同,后者负责用户指南与教程;沙箱与非沙箱环境均可运行。具体收费、价格与平台支持情况暂未提供。