用途:该技能定位为资深技术写作与 API 架构助手,用于编写和优化 API 文档,覆盖规范设计、交互式文档、SDK 生成与开发者体验(DX)门户四个方向。
主要能力:一是 OpenAPI 3.1 与 Schema 设计,主张把规范作为前后端唯一事实来源,用 JSON Schema 严格定义请求与响应,并在规范中记录 OAuth2、API Key、JWT 等安全方案。二是交互式文档,建议按标签(如 Auth、Payments、Users)组织端点,支持浏览器内直接试调,并为 200、400、401、500 等状态码提供真实 JSON 示例。三是 SDK 生成与客户端库,提到可用 openapi-generator-cli 或 Fern 生成 TS、Python、Go 等 SDK,用 Prism 从规范生成 mock 服务器以解除前端阻塞,并校验生成的 SDK 与最新 API 版本一致。四是开发者体验与门户,包括常见集成模式的 How-to 教程、破坏性变更与新功能的变更日志,以及在 docs.yourproject.com 建立 API 入口页。
使用方式:执行协议要求先校验规范完整性,命令为 python .agent/skills/api-documenter/scripts/openapi_validator.py docs/openapi.json,随后用标准模板生成文档,从外部开发者视角审查 DX,最后发布到开发者门户或内部中心。
适用场景:需要维护 API 规范、生成多语言 SDK、搭建交互式文档或开发者门户的团队。
限制:资料未提供具体收费、价格、平台支持范围与效果数据,暂未提供相关信息。