System Design FAQ
REST API设计
REST(Representational State Transfer) 是一种软件架构风格,不是协议。REST API 是基于 HTTP 协议的一种接口设计方式,它强调资源的表示和状态转移。
- 资源(Resource):系统中的实体,如
users、orders、products。 - URI(统一资源标识符):资源的唯一地址,例如
/users/123表示 ID 为 123 的用户。 - HTTP 方法:用于操作资源的动作(见下表)。
| 操作类型 | HTTP 方法 | 示例 URI | 意义 |
|---|---|---|---|
| 查询资源 | GET | /users/1 | 获取 ID=1 的用户 |
| 创建资源 | POST | /users | 创建一个新用户 |
| 更新资源 | PUT 或 PATCH | /users/1 | 更新 ID=1 的用户 |
| 删除资源 | DELETE | /users/1 | 删除 ID=1 的用户 |
著名产品
- GitHub API https://docs.github.com/en/rest
- Twitter API V2 https://developer.twitter.com/en/docs/twitter-api