用途:从 OpenAPI 3.0+ 规范生成综合、可交互的 API 文档站点,适用于需要完整 API 文档的项目。
主要能力:
- 审阅 OpenAPI 规范完整性,检查每个操作是否有摘要、描述、参数说明及请求/响应示例。
- 用 Markdown 补充入门指南、认证流程说明与限流说明(写入 info.description 或 x-documentation 扩展)。
- 用 Redoc 或 Stoplight Elements 生成带 Try It 功能的交互文档。
- 为每个端点生成 curl、JavaScript(fetch/axios)、Python(requests/httpx)、Go(net/http)可运行示例,并注入认证头。
- 生成认证指南,覆盖 API Key、OAuth2 授权码流程、JWT 生命周期与凭证轮换。
- 生成按 HTTP 状态码组织的错误参考表,含错误码含义、常见原因与解决步骤,并提供可搜索索引。
- 配置文档版本切换(如 v1/v2)与差异高亮,展示版本变化。
- 在 OpenAPI 规范变更时自动重建文档站点并部署,含缓存失效。
前置条件:OpenAPI 3.0+ 规范(含描述、示例和完整 schema 定义);文档生成器(Redoc、Stoplight Elements、Swagger UI 或带 OpenAPI 插件的 Docusaurus);多语言代码示例生成器;静态站点托管(GitHub Pages、Netlify、Vercel);定制品牌资源(logo、配色)。
输出:生成文档站点(HTML/CSS/JS)、认证指南 authentication.md、快速入门 getting-started.md、错误参考 errors.md、各端点多语言示例目录,以及带品牌配置的 redoc.yaml。
适用场景:Stripe 风格三栏文档布局(左导航、中描述、右代码示例,含语言切换);并列托管多版本文档并附变更日志与迁移步骤;将 API 参考、教程、用例指南、Webhook 文档与 SDK 安装说明整合为可搜索开发者门户。
限制与错误处理:规范缺少示例时需用 Faker 生成或在 lint 中标记;文档需与 API 发布流水线绑定以避免版本过期;Try It 请求需在 API 服务端为文档域名配置 CORS 或使用代理;代码示例可能因 SDK 弃用方法或错误导入出错,需针对 staging API 自动测试;内容更新后需重建全文搜索索引(Algolia/Lunr)。完整实现与错误模式见 ${CLAUDE_SKILL_DIR}/references/implementation.md 与 ${CLAUDE_SKILL_DIR}/references/errors.md。官方资源:Redoc https://redocly.com/redoc ,Stoplight Elements https://stoplight.io/open-source/elements ,Swagger UI https://swagger.io/tools/swagger-ui/ 。