从代码生成全面、开发者友好的API文档包括端点、参数、示例和最佳实践。技能概述api-documentation-generator 技能自动从代码库生成清晰、全面的API文档。此技能帮助您创建专业的文档包括端点描述、请求/响应示例、认证详情、错误处理和使用指南。适用于REST API、GraphQL API和WebSocket API。下载地址https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation-generator触发条件在以下情况下应该调用此技能:需要为新API编写文档更新现有API文档API缺乏清晰的文档为新开发者提供API入门为外部用户准备API文档创建OpenAPI/Swagger规范处理过程1. 分析API结构首先检查您的API代码库以了解可用的端点和路由HTTP方法GET、POST、PUT、DELETE等请求参数和主体结构响应格式和状态码认证和授权要求错误处理模式2. 生成端点文档为每个端点创建文档包括HTTP方法和URL路径功能简述认证要求速率限制信息请求规范路径参数、查询参数、请求头、请求体响应规范成功响应、错误响应代码示例cURL、JavaScript、Python等3. 添加使用指南入门指南认证设置常见用例最佳实践速率限制详情分页模式过滤和排序选项4. 文档化错误处理所有可能的错误代码错误消息格式故障排除指南常见错误场景和解决方案5. 创建交互式示例Postman集合OpenAPI/Swagger规范交互式代码示例示例响应支持的API类型REST API- 标准RESTful API文档GraphQL API- GraphQL模式和查询文档WebSocket API- WebSocket连接和消息文档使用限制仅当任务明确匹配上述范围时使用此技能不要将输出替代环境特定的验证、测试或专家审查如果缺少必需的输入、权限、安全边界或成功标准请停止并请求澄清