背景
- 传统的RPC API设计偏向于传统的C/S架构，对于B/S模式的WEB应用已经不适用
- 需要一种全新的结构清晰、符合标准、易于理解、扩展方便的设计准则
RESTful API
-
RESTful API是目前比较成熟的一套互联网应用程序的API设计理论 - 符合
REST设计理念的WEB API，我们称之为RESTful API - REST的全称是
Representational State Transfer，即表述性状态转移
Representational State Transfer
-
Representational，即Resource的表现层，用于表述资源的一种方式- 常用的表述方式有，JSON|XML|HTML|TEXT等
-
Resource，就是网络上的一个实体，或者说是网络上的一个具体信息- 可以是一个文本|图片|歌曲|服务，总之就是一个具体的实体
- 可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI
- 要获取这个资源，访问它的URI就可以，因此URI就成了每一个Resource的地址或独一无二的识别符
- State Transfer，即状态转化
- 访问一个网站，就代表了客户端和服务器的一个互动过程，过程中势必涉及到数据和状态的变化
- 互联网通信协议HTTP协议，是一个无状态协议，这意味着，所有的状态都保存在服务器端
- 因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"
HTTP操作
状态转化由HTTP操作实现，并不由URI地址表示
| 操作 | HTTP Method | URI |
|---|---|---|
| 获取列表数据 | GET | /collection |
| 添加数据 | POST | /collection |
| 查看数据 | GET | /collection/{id} |
| 修改全量数据 | PUT | /collection/{id} |
| 修改部分数据 | PATCH | /collection/{id} |
| 删除数据 | DELETE | /collection/{id} |
注：其中collection指资源集合（复数形式），比如users、materials、groups
常见错误集：
# 路径中存在动作词
POST /insert_material
# 不应用单数,应用集合（复数）
POST /material
# PUT是全量更新，此时会导致所有没有值的属性都被置空，而本意是改一个属性
PUT /materials/{id}
body：{"location":"A1"}
# 网上汇款，从账户1向账户2汇款500元，动词不应该在URI中
POST /accounts/1/transfer/500/to/2
# 正确的写法是将操作服务化
POST /transaction
body:{from:1, to:2, amount:500.00}
HTTP操作延伸
由于RESTful中，只能对单一资源进行，但是实际应用中又有大量的批量场景，因此对RESTful进行扩展，增加一个服务：batch
注：该定义非RESTful准则，仅用于自己项目内部约定，供参考
| 操作 | HTTP Method | URI |
|---|---|---|
| 添加数据 | POST | /collection/batch |
| 修改全量数据 | PUT | /collection/batch |
| 修改部分数据 | PATCH | /collection/batch |
| 删除数据 | DELETE | /collection/{id},{id},... |
过滤信息（Filtering）
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果,下面是一些常见的参数:
- ?limit=10：指定返回记录的数量
- ?offset=10：指定返回记录的开始位置。
- ?page=2&per_page=100：指定第几页，以及每页的记录数。
- ?sortby=name&order=[asc|desc]：指定返回结果按照哪个属性排序，以及排序顺序
- ?animal_type_id=1：指定筛选条件
返回结果
针对不同操作，服务器向用户返回的结果应该符合以下规范：
- GET /collection：返回资源对象的列表（数组）
- GET /collection/resource：返回单个资源对象
- POST /collection：返回新生成的资源对象
- PUT /collection/resource：返回完整的资源对象
- PATCH /collection/resource：返回完整的资源对象
- DELETE /collection/resource：返回一个空文档
针对批量操作：
- POST /collection/patch：返回新生成的资源对象列表
- PUT /collection/patch：返回完整的资源对象列表
- PATCH /collection/patch：返回完整的资源对象列表
- DELETE /collection/{id},{id}：返回一个所有资源删除成功与否的结果列表
状态码（Status Codes）
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）:
- 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）
- 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
- 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
- 204 NO CONTENT - [DELETE]：用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
- 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
- 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
- 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
- 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
- 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
- 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功
状态码的完全列表参见这里
域名
应该尽量将API部署在专用域名之下,如：
- http(s)://api.example.com/
如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下:
- http(s)://www.example.com/api/
版本号
应该将API的版本号放入URL,如：
另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观，如：
- https://api.example.com/
- Accept: vnd.example-com.foo+json; version=1.0
网友评论