Django Rest Framework（一）

一、什么是RESTful

REST与技术无关，代表一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”。

REST从资源的角度审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获取这些表征致使这些应用转变状态。

所有的数据，不管是通过网络获取的还是操作（增删改查）的数据都是资源，将一切数据视为资源是REST区别于其他架构风格的最本质属性。

对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即面向资源架构（ROA：Resource Oriented Architecture）。

二、RESTful API设计

1.API与用户的通信协议，总是使用HTTPS协议。

2.域名

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

3.路径，视网络上任何东西都是资源，均使用名词表示（可复数）

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

4.method

GET 从服务器取资源（一项或多项）
POST 在服务器新建一个资源
PUT 在服务器更新资源（客户端提供改变后的完整资源）
PATCH 在服务器更新资源（客户端提供改变的属性）
DELETE 从服务器删除资源

5.过滤，通过在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：指定筛选条件

6.状态码

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

常用状态码列表