01 Django REST Framework 介绍

01-Django REST Framework的介绍

API指南：https://www.cnblogs.com/victorwu/p/7418368.html

Django REST框架是一个用于构建Web API的强大而灵活的工具包。

您可能希望使用REST框架的一些原因：

1. Web可浏览API对于开发人员来说是一个巨大的可用性胜利。
2. 身份验证策略，包括OAuth1a和OAuth2的包。
3. 支持ORM和非ORM数据源的序列化。
4. 自始至终都可以定制-如果不需要更强大的功能，只需使用常规的基于函数的视图。
5. 广泛的文档和良好的社区支持。
6. 被国际知名公司使用和信任，包括Mozilla、Red Hat、Heroku和EventBrite。

02-为什么要用Django REST Framework

1. 前后端分离的业务需要搭建API

2. 基于Django快速开发 RESTful API

03-状态码

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

04-RESTful API介绍

REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”或“表现层状态转化”。
阮一峰 RESTful设计指南

05-Method

常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

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

还有两个不常用的HTTP动词。

HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

06-协议

API与用户的通信协议，总是使用HTTPs协议。

07-域名

1. 应该尽量将API部署在专用域名之下。
https://api.example.com

2. 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。
https://example.org/api/

08-版本

1.  将版本信息放在URL中，如：https://api.example.com/v1/

2. 将版本信息放在请求头中。但不如放入URL方便和直观。Github采用这种做法。

09-路径

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

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

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

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

10-过滤信息（Filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。

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

11-错误处理

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

12-返回结果

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

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

13-Hypermedia API

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

比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。

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

上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。

14-其他

（1）API的身份认证应该使用OAuth 2.0框架。

（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。