用途:在设计与实现 REST API 时提供规范参考,适用于规划新端点、定义 DTO 与整体 API 结构。
主要能力:
- URL 结构:给出资源的标准 CRUD 路由,如 GET /api/v1/resources、GET /api/v1/resources/{id}、POST /api/v1/resources、PUT /api/v1/resources/{id}、PATCH /api/v1/resources/{id}、DELETE /api/v1/resources/{id},并说明嵌套资源写法,如 GET /api/v1/parents/{id}/children。
- HTTP 状态码:列出 200、201、204、400、401、403、404、409、422、500 及各自适用场景。
- 请求/响应设计:集合响应包含 data 与 pagination(page、pageSize、totalItems、totalPages);单资源响应含 id、name、createdAt、updatedAt;错误响应含 error.code、error.message、error.details 字段级信息。
- 查询参数:支持过滤(status、type)、排序(sort=createdAt,desc)、分页(page、pageSize)、字段选择(fields)、搜索(search)。
- 幂等性:带唯一标识的 POST 遇重复应返回已有资源(200);PUT/DELETE 应幂等;可用 Pair<Result, Boolean> 模式区分新建与已存在。
- 版本控制:采用 URL 路径版本(/api/v1/、/api/v2/),破坏性变更时升版本,迁移期支持旧版本。
- 安全:在 API 边界校验输入,使用参数化查询(JOOQ 可处理),在服务层检查授权,不暴露内部 ID 或敏感数据,对公开端点限流。
使用方式:作为设计阶段的检查清单与约定参考,按上述模式定义端点、状态码与响应结构。
限制:资料未提供具体安装命令、运行环境、收费方式或平台支持信息,暂未提供。