DRF之RESTful规范

RESTful

起源

　　REST这个词是由Roy Thomas Fielding在2000年提出的。是Representational State Transfer的缩写，我对这个词组的翻译是"表现层状态转化"。

资源 Resources

　　所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。

表现层（Representation）

　　"资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层"（Representation）。

　　比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。

状态转化（State Transfer）

　　访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。

综合上面的解释，我们总结一下什么是RESTful：

　　（1）每一个URI代表一种资源；

　　（2）客户端和服务器之间，传递这种资源的某种表现层；

　　（3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

RESTful API设计

• API与用户的通信协议，总是使用HTTPS协议。
• 域名 
  • https://api.user.com                         尽量将API部署在专用域名（会存在跨域问题）
  • https://user.org/api/                         API很简单
• 版本
  • URL，如：https://api.user.com/v1/
  • 请求头                                                  跨域时，引发发送多次请求
• 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
• https://api.user.com/v1/employees
• method
  • GET      ：获取资源（服务器）
  • POST    ：创建新资源（服务器）
  • PUT      ：更新资源（用户修改之后在服务端进行更新）
  • PATCH  ：局部更新资源（客户端提供改变的属性）
  • DELETE ：从服务器删除资源
• 过滤，通过在url上传参的形式传递搜索条件
  • https://api.user.com/v1/employees?limit=10：指定返回记录的数量
  • https://api.user.com/v1/employees?offset=10：指定返回记录的开始位置
  • https://api.user.com/v1/employees?page=2&per_page=100：指定第几页，以及每页的记录数
  • https://api.user.com/v1/employees?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
  • https://api.user.com/v1/employees?user_type_id=1：指定筛选条件
• 状态码

OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
NO CONTENT - [DELETE]：用户删除数据成功。
INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

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

• 错误处理，状态码是4xx时，应返回错误信息，error当做key。

{
    "code": 4000,"msg":"用户名错误"
}

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

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

• Hypermedia API，RESTful API最好做到Hypermedia，就是要返回结果中提供链接。