【研发类-API开发Skills】api-documentation 技能
API文档工作流用于生成OpenAPI规范、创建开发者指南和维护全面的API文档。技能概述api-documentation 技能是一个专门的工作流技能用于创建全面的API文档包括OpenAPI/Swagger规范、开发者指南、代码示例和交互式文档。该技能通过多个阶段系统地完成API文档的创建和维护工作。下载地址https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation触发条件在以下情况下应该调用此技能:创建API文档生成OpenAPI规范编写开发者指南添加代码示例设置API门户工作流阶段阶段1: API发现盘点端点、文档请求/响应、识别认证方式、映射错误代码、注意速率限制阶段2: OpenAPI规范创建OpenAPI架构、定义路径、添加架构、配置安全、添加示例阶段3: 开发者指南创建入门指南、编写认证指南、文档化常见模式、添加故障排除、创建FAQ阶段4: 代码示例创建示例请求、编写SDK示例、添加curl示例、创建教程、测试示例阶段5: 交互式文档设置Swagger UI、配置Redoc、添加try-it功能、测试交互性、部署文档阶段6: 文档站点选择平台、设计结构、创建页面、添加导航、配置搜索阶段7: 维护设置自动生成、配置验证、添加审查流程、安排更新、监控反馈质量检查清单OpenAPI规范完整开发者指南已编写代码示例可工作交互式文档功能正常文档已部署相关技能documentation- 文档api-development- API开发development- 开发使用限制仅当任务明确匹配上述范围时使用此技能不要将输出替代环境特定的验证、测试或专家审查如果缺少必需的输入、权限、安全边界或成功标准请停止并请求澄清