SuperAPI AI 工具集

designing-apis

编程与开发

查看项目

更新于 10-15 20:12

技能介绍

用途:在创建新 API、设计端点或评审接口契约时,提供一套 REST 与 GraphQL 的设计流程与规范。触发场景为设计 REST/GraphQL 端点、API 契约、版本控制、请求/响应格式;纯内部代码且无 API 暴露面时可跳过。

主要能力:提供七步设计流程(定义资源与关系、设计端点结构、定义请求/响应格式、规划错误处理、添加认证授权、用 OpenAPI 规范编写文档、按清单校验设计)。REST 部分给出基于名词的 URL 结构(如 GET /users、POST /users/:id/orders)、查询参数过滤与分页(如 /users?page=2&limit=20&sort=-createdAt)、常用 HTTP 状态码含义与用例(200/201/204/400/401/403/404/409/422/429/500)、成功/列表/错误三类响应格式示例,以及 URL 版本控制(/api/v1/users)与请求头版本控制。认证模式包含 JWT Bearer Token 与 API Key,并列出速率限制响应头(X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset、Retry-After)。GraphQL 部分给出 Query、Mutation、类型、输入与 Payload 的 schema 设计示例。另附 OpenAPI 3.0 模板指引与设计校验清单、安全清单(HTTPS、认证、授权、输入校验、速率限制、请求大小限制、CORS、URL 不含敏感数据、审计日志)。

使用方式:按清单逐步推进设计,完成后对照校验清单检查;校验不通过则回到对应步骤修正。

适用场景:新建 API、设计端点、评审接口契约。

限制:资料未提供具体安装命令、运行环境或收费信息;OpenAPI 完整模板需参见其 OPENAPI-TEMPLATE.md,本文未展开。