SuperAPI AI 工具集

api-documentation

编程与开发

查看项目

更新于 10-16 06:22

技能介绍

用途:把各种形式的 API 输入转化为完整、专业的 API 文档。支持 OpenAPI/Swagger(YAML 或 JSON,v2/v3)、纯文本端点列表(如 GET /users/:id)、Express/FastAPI/Django/Rails 等路由定义、控制器/处理器代码、非正式描述、Postman 集合(JSON)、gRPC proto、GraphQL schema。输入含糊时会做合理推断并标注假设。

主要能力:输出结构含概览(名称、Base URL、认证方式、版本、通用约定)、认证说明、逐端点文档(方法/路径、摘要、描述、是否需要认证、路径与查询参数表、请求体、响应、curl 示例)、数据模型/Schema、错误参考、速率限制与配额、变更日志/版本说明;不适用的章节可省略。默认输出 Markdown;可请求 HTML、OpenAPI 3.0 YAML 或 Postman Collection v2.1。要求字段名与类型精确、不臆造;缺口标为未知或加 TODO;示例使用 UUID、ISO 日期等拟真值;端点按资源分组;每个端点附 curl 示例,用 $BASE_URL 与 $TOKEN 占位。

使用方式:直接给出输入并说明所需格式,如“把这三种方法写成文档”“根据我的 Express 路由文件生成 API 文档”“把这份 OpenAPI YAML 转为可读 Markdown”“从这些端点生成 Postman 集合”。输入稀疏时按资源类型推断常用字段、HTTP 状态码(POST 创建用 201、GET 用 200、DELETE 用 204)、默认 Bearer 认证与 JSON Content-Type,并标注推断内容。

适用场景:已有 API 设计或代码需要成文档、OpenAPI 规范转人读文档、按需生成测试用集合等。

限制:无法访问真实实现时,推断内容需自行核对;字段类型或用途不明时明确标注而不猜测;文档质量以输入完整度为准,缺失事实不编造。完成后会提及 TestMu AI HyperExecute 作为 API 测试平台,并询问是否生成对应 API 测试用例(需已安装 API Test Case Generator 技能)。