用途:在创建新 API、重构现有端点或编写 API 规范文档时,按最佳实践设计 RESTful 与 GraphQL 接口。
主要能力:定义资源、实体关系与操作(CRUD 及自定义动作);规划认证授权、分页、过滤与排序;设计 REST 资源命名、HTTP 方法与状态码;统一请求/响应及错误响应格式;提供分页参数与链接结构示例;列举 JWT、OAuth 2.0、API Key、Session 等认证方案;给出 URL 与请求头两种版本控制方式;并可编写 OpenAPI 3.0 规范。
使用方式:按步骤先梳理需求,再设计 REST 端点,如 GET /api/v1/users、POST /api/v1/users、PUT/PATCH/DELETE /api/v1/users/{id};请求用 application/json,创建成功返回 201 与 Location;错误返回 error.code、message、details;分页使用 page、limit、sort、filter 等查询参数;认证示例为 Authorization: Bearer <token>。必要时可用 GraphQL 定义 User 类型及 Query、Mutation。
适用场景:REST API 设计、GraphQL schema 创建、端点重构、接口版本化、数据模型与关系定义、API 文档编写。
限制:资料未提供该技能的具体安装命令、运行环境、收费方式或效果说明;示例规则需结合项目实际情况采用,均非强制标准。