该技能用于指导干净的、一致的、可维护的 API 设计,适用场景包括设计新 API 端点、评审 API 契约、规划 API 版本策略、定义请求/响应 schema、构建 GraphQL schema 以及编写 API 文档。
REST 设计要点:以资源为中心组织接口(如 GET /users、GET /users/123、POST /users、PUT /users/123、DELETE /users/123),避免动作式 URL;遵循 HTTP 方法语义(GET 安全幂等、POST 创建非幂等、PUT 替换幂等、PATCH 局部更新幂等、DELETE 幂等);URL 结构可含集合、单项、嵌套、非 CRUD 动作用 POST、过滤、分页(?page=2&limit=20)与排序。请求设计区分路径参数与查询参数,并给出创建、局部更新、批量操作的请求体模式。
响应与错误:建议统一响应信封,成功含 data 与 meta,集合含分页元数据,错误含 code、message、details 及时间戳与 requestId;给出常见 HTTP 状态码分类及状态码决策树。版本策略包含 URL 路径版本(推荐)、Header 版本与查询参数版本三种并列出优缺点。
GraphQL 部分涵盖 schema 优先设计、输入类型模式、游标分页与偏移分页。认证鉴权介绍 Bearer Token、API Key、Basic Auth、OAuth 2.0 及 401/403 区别;错误处理给出标准化错误格式与常见错误码表;API 文档给出 OpenAPI/Swagger 结构。最后列出需避免的反模式,如 URL 含动词、忽略 HTTP 方法、命名不一致、泄露实现、缺少分页、忽略幂等性、无版本控制。该技能未提供具体安装命令或收费信息。