用途:当 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 及带装饰器的行内注释。对缺失信息会给出补充建议(参数、返回值、错误码),并生成拟真示例响应。
使用方式:作为 Claude Code 技能安装后,在相关代码变动或提出文档需求时激活。生成结果可配合 Swagger UI 使用,例如以 node 引入 swagger-ui-express 并用 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(spec)) 挂载;也可导入 Postman(File → Import → openapi.json)或用于 Docusaurus、MkDocs、Redoc、Stoplight 等文档站点。需要自定义标准时可复制技能目录:cp -r ~/.claude/skills/documentation/api-documenter ~/.claude/skills/documentation/company-api-documenter 后编辑。
适用场景:接口变更后同步文档、为新端点补充 OpenAPI 规范、生成可导入测试工具的接口描述、与 @docs-writer 子智能体配合先出规范再出用户指南。
限制:资料未提供具体收费、价格、性能与效果数据;无网络要求、无需配置、兼容沙箱环境,会在文件系统写入 OpenAPI 文件。