SuperAPI AI 工具集

designing-apis

编程与开发

查看项目

更新于 10-16 05:06

技能介绍

用途:在创建新端点、定义接口契约或改进 API 易用性时,帮助设计整洁、一致的 API,覆盖 REST、版本管理与错误处理。

主要能力与工作流:识别资源与关系;定义 URL 结构与 HTTP 方法;定义请求/响应载荷与 schema;定义错误响应;创建 OpenAPI 规范。

REST 原则:资源命名使用名词而非动词(/users 而非 /getUsers),使用复数(/users 而非 /user),使用 kebab-case(/user-profiles 而非 /userProfiles),关系嵌套(/users/{id}/orders)。HTTP 方法:GET 读取且幂等,POST 创建非幂等,PUT 替换幂等,PATCH 更新幂等,DELETE 删除幂等。状态码涵盖 200、201、204、400、401、403、404、409、422、500。错误响应格式包含 error.code、error.message 与 details 字段列表。

版本管理:推荐 URL 版本(GET /api/v1/users、GET /api/v2/users),也可用请求头版本(Accept: application/vnd.api+json;version=1)。分页响应包含 data 与 pagination(page、per_page、total、total_pages)。

使用方式:按上述工作流逐步产出资源、端点、请求响应、错误与 OpenAPI 规范。资料提供 OpenAPI 3.0.0 示例片段,展示 /users 的 GET 列表接口与响应 schema 引用。

限制:资料未提供安装命令、收费、价格、平台或具体使用步骤等事实。