用途:该技能用于创建和维护高质量 API 文档,提升开发者体验与集成效率。适用场景包括编写或更新 OpenAPI/AsyncAPI 规范、搭建开发者门户与 SDK 文档、改进文档质量与可发现性、从规范生成代码示例或 SDK。不适合仅需内部速记、纯后端实现无文档需求、或没有 API 面与规范可写的任务。
主要能力:支持 OpenAPI 3.1+ 规范编写、API-first 契约驱动文档、AsyncAPI 事件与实时 API、GraphQL schema 与 SDL、JSON Schema 校验、Webhook 文档;提供 AI 辅助内容生成与更新、多语言代码示例生成、一致性检查与示例测试;支持 Swagger UI、Redoc、Stoplight Studio、Insomnia、Postman、Docusaurus 等交互式文档与门户;涵盖开发者门户架构、多 API 组织、认证与 API Key 管理、社区与反馈、分析与搜索优化;支持多语言 SDK 生成、包管理分发、CI/CD 自动发布;覆盖 OAuth 2.0、OpenID Connect、JWT、限流、CORS、Webhook 签名等安全文档;包含契约校验、示例与 curl 测试、响应校验、Mock 服务器、集成测试;以及版本策略、破坏性变更迁移指南、弃用通知、变更日志与向后兼容文档。
使用方式:先明确目标用户、API 范围与文档目标;创建或校验带示例和认证流程的规范;构建交互式文档并用测试保证准确性;规划维护、版本与迁移。遵循 docs-as-code 原则,将文档纳入 Git 与 CI/CD 流程。
限制:资料未提供具体安装命令、收费价格、平台支持范围或效果数据,暂未提供。