SuperAPI AI 工具集

loom-api-documentation

编程与开发

查看项目

更新于 10-15 20:28

技能介绍

用途:为 REST API 编写开发者可用的文档,核心是以准确的 OpenAPI 规范作为唯一事实来源,再据此生成或同步端点参考、认证、错误与版本化指南,重点在正确性与防漂移,而非文风。

主要能力:覆盖认证、各环境 base URL、每个端点与操作、请求/响应 schema、全部响应码(含错误)、限流(含响应头)、分页、版本与弃用策略。支持 spec-first(手写 OpenAPI,生成服务端桩、客户端与 mock)与 code-first(注解处理器,由框架输出规范,如 FastAPI、springdoc、drf-spectacular、tsoa)两种路线,并建议在 CI 中强制契约(lint、示例校验、破坏性变更 diff)。

OpenAPI 3.1 要点:对齐 JSON Schema 2020-12;取消 nullable: true,改用 type: [string, "null"];type 可为数组;exclusiveMinimum/Maximum 为数值;顶层 webhooks 描述 API 发出的事件;Schema 用 examples(数组),Media Type/Parameter 用 example 或 examples(映射);info.license.identifier 支持 SPDX;$ref 可与同级关键字并存。需注意部分工具对 3.1 支持不完整。

用法与工具:可用 Redoc 渲染、Swagger UI 试用、Stoplight Elements 嵌入;Spectral/Redocly 做 lint,Redocly bundle 打包,OpenAPI Generator 生成客户端,openapi2postmanv2 转 Postman,Prism 做 mock,Dredd/Schemathesis 做契约测试,oasdiff 检测破坏性变更。示例命令如 npx @redocly/cli lint openapi.yaml、prism mock openapi.yaml、oasdiff breaking old.yaml new.yaml。

限制:资料未提供该技能的具体安装方式、收费与平台信息;文档质量依赖规范与实现同步,未测试的文档视为不可信。