用途:这是一个从代码库自动生成 API 文档的技能,帮助创建包含端点描述、请求与响应示例、认证细节、错误处理和用法指南的文档,适用于 REST、GraphQL 和 WebSocket API。
主要能力:分析 API 结构与路由、HTTP 方法、请求参数与请求体、响应格式与状态码、认证授权要求及错误处理模式;为每个端点生成端点详情、请求规范、响应规范与多语言代码示例;补充入门指南、认证设置、常见用例、最佳实践、速率限制、分页、过滤与排序说明;整理错误代码与排错指南;在可行时提供 Postman 集合、OpenAPI/Swagger 规范与交互式示例。
使用方式:在需要编写新 API 文档、更新现有文档、API 缺少清晰说明、帮助新开发者上手、面向外部用户准备文档或创建 OpenAPI/Swagger 规范时使用。技能按分析结构、生成端点文档、添加用法指南、记录错误处理、创建交互式示例的步骤进行。文档结构建议包括简介、认证、快速开始、端点、数据模型、错误处理、速率限制、变更日志和 SDK 工具。OpenAPI 与 Postman 集合给出的是格式示例,并非固定安装命令。
适用场景与限制:适合需要系统化整理 API 说明的开发团队。资料未提供具体平台限制、收费或价格信息;也不保证能覆盖所有语言或框架,实际输出取决于代码可分析程度。