RESTful规范

一、什么是RESTful

RESTful全名“Representational State Transfer”，即“表征状态转移”，是一种架构风格。
RESTful将网络上的一切都视为资源，对于这种面相资源的架构风格，有人提出了面相资源架构（ROA：Resource Oriented Architecture）

二、RESTful API设计

1. API与用户的通信协议，总是使用HTTPs协议。(优点:和明文的http相比,加密,更安全)

2. 域名

https://api.example.com              尽量将API部署在专用域名（会存在跨域问题）
https://example.org/api/             API很简单（推荐）

3. 把版本号写在请求头中

https://api.example.com/v1/ 

4. 网络上任何东西都是资源，均用名词表示

127.0.0.1/get_all_book/ #非RESTful写法
127.0.0.1/books/ #RESTful写法

5. 通过method请求方式区别要执行的操作

127.0.0.1/books/  get请求：表示获取所有图书
127.0.0.1/books/1  get请求：表示获取id为1的图书
127.0.0.1/books/  post请求：表示新增一本书
127.0.0.1/books/  delete请求：表示删除一本书
127.0.0.1/books/  put/patch请求：表示修改一本书

6. 过滤，通过URL传参的方式传递搜索条件

https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

7. 状态码

1 开头：服务器正在处理
2 开头：服务器处理成功
3 开头：重定向
4 开头：客户端错误
5 开头：服务器错误
在返回的数据中携带状态码

详细：

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

8. 错误处理，应以键值对方式返回错误信息，error当做key

9.返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范：

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

10. Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么：

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}