SuperAPI AI 工具集

api-documentation-generator

编程与开发

查看项目

更新于 10-16 09:28

技能介绍

用途:从代码库自动生成清晰、完整的 API 文档,帮助团队记录新 API、更新旧文档、为外部用户编写说明或生成 OpenAPI/Swagger 规范,也适合新开发者了解接口。

主要能力:先分析代码结构,识别可用端点与路由、HTTP 方法、请求参数与请求体、响应格式与状态码、认证授权要求及错误处理模式。随后为每个端点生成文档,包括方法、路径、用途说明、认证要求、限流信息(如有)、路径与查询参数、请求头、请求体模式(含类型与校验规则)、成功与错误响应、响应头,以及 cURL、JavaScript/TypeScript、Python 等代码示例。同时可补充入门指南、认证设置、常见用例、最佳实践、分页、过滤排序,并整理全部错误码、错误消息格式与排查步骤。在可行时提供 Postman 集合、OpenAPI/Swagger 规范、交互式示例与示例响应。

使用方式:将 API 代码库交给该技能,按上述步骤生成文档;示例中展示了 REST 端点(如 POST /api/v1/users)、GraphQL 查询与认证流程的文档形态,引用命令如 curl -X POST https://api.example.com/api/v1/users 保持原样。

适用场景:REST、GraphQL、WebSocket API 的文档编写与维护。

限制:输出不能替代针对具体环境的验证、测试或专家评审;若缺少必要输入、权限、安全边界或成功标准,应先暂停并请求澄清。