导入
REST API 基础与设计原则
学习设计可扩展且可预测的 REST API 的核心原则和最佳实践。
...
客户端 API 服务器架构
表格
| HTTP 方法 | 示例端点 | 用途 |
|---|---|---|
| GET | /users | 获取所有用户。 |
| GET | /users/:id | 获取指定用户。 |
| POST | /users | 创建新用户。 |
| PUT | /users/:id | 替换整个用户资源。 |
| PATCH | /users/:id | 更新用户的特定字段。 |
| DELETE | /users/:id | 删除用户。 |
结构良好的 JSON 响应示例
1{ 2 "status": "success", 3 "data": { 4 "id": 1, 5 "title": "Learn Express.js", 6 "completed": false 7 } 8}
表格
| HTTP 状态码 | 含义 |
|---|---|
| 200 OK | 请求成功。 |
| 201 Created | 已成功创建新资源。 |
| 400 Bad Request | 客户端发送了无效请求。 |
| 401 Unauthorized | 需要身份验证。 |
| 404 Not Found | 请求的资源不存在。 |
| 500 Internal Server Error | 发生服务器内部错误。 |
开发者通常使用以下三种策略之一对 API 进行版本管理。
-
URL 版本控制（推荐）：
该方法简单明确，广泛使用，将版本号直接包含在 URL 路径中，例如：
/api/v1/tasks -
请求头版本控制：
客户端通过请求头指定所需版本。例如：1Accept: application/vnd.myapi.v2+json此方式保持 URL 简洁，但需要客户端进行额外处理。
-
查询参数版本控制：
将目标版本作为查询字符串传递。例如：
/tasks?version=1
实现简单，但使用较少。