RESTful 规范

在作的前几个小网站，每每过程是，后端在编写的时候须要前端提供静态文件的支持，因此每每，前端后端相互依赖，相互等待。而先后端分离使得先后端解耦，只要定义规范的接口（url，API），后端根据接口返回相应的数据（json， xml等），图片多是（jpg，png等）。这就提升了开发效率，另外一方面，因为先后端分离，使得一个后台能够支持多个前台，pc端，移动端，甚至微信小程序（下降了成本）。
网站也叫web App，只不过网站可能更注重内容的显示，而App在功能处理方面更增强大。若是你还说淘宝，京东这样能处理大流量的电商平台还只是简单的网站的话，可能就说不过去了。与传统的移动端App相比，设计架构（客户端/服务端）应该都是相同的，MVC模式，模板渲染层，业务逻辑层，数据存储层。web App每次打开页面都要将静态文件加载到浏览器端，因此很大程度上具备了高时延的特色，而移动端App是把静态文件事先下载到手机，而后在打开的时候进行数据的填充渲染，这就使得手机软件的占用空间很大，不少人从原本在高质量的网络环境下的打开一个手机浏览器就能够冲浪的状况下，还要下载一个几十甚至上百兆的软件，这是一个很不爽的事。另外由于网站虽然具备高时延的特色，一些对响应时间要求不大的网页游戏，其实也能够由网站实现。博主能力有限，表述不合适，请见谅
切回正题。

1、RESTful简介

RESTful架构，就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，因此正获得愈来愈多网站的采用。
REST（英文：Representational State Transfer，简称REST）描述了一个架构样式的网络系统，好比 web 应用程序。它首次出如今 2000 年 Roy Fielding 的博士论文中，他是 HTTP 规范的主要编写者之一。值得注意的是REST并无一个明确的标准，而更像是一种设计的风格。
R：资源（Resources），REST的名称"表现层状态转化"中，省略了主语。"表现层"其实指的是"资源"（Resources）的"表现层"。所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它能够是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你能够用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就能够，所以URI就成了每个资源的地址或独一无二的识别符。所谓"上网"，就是与互联网上一系列的"资源"互动，调用它的URI。（面向资源编程）
E：表现层（Representation），"资源"是一种信息实体，它能够有多种外在表现形式。咱们把"资源"具体呈现出来的形式，叫作它的"表现层"（Representation）。好比，文本能够用txt格式表现，也能够用HTML格式、XML格式、JSON格式表现，甚至能够采用二进制格式；图片能够用JPG格式表现，也能够用PNG格式表现。URI只表明资源的实体，不表明它的形式。严格地说，有些网址最后的".html"后缀名是没必要要的，由于这个后缀名表示格式，属于"表现层"范畴，而URI应该只表明"资源"的位置。它的具体表现形式，应该HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。（django的接受到客户端发送的请求request后会对request的请求头headers作解析，判断数据的格式content-type）
ST：状态转化（State Transfer），访问一个网站，就表明了客户端和服务器的一个互动过程。在这个过程当中，势必涉及到数据和状态的变化。互联网通讯协议HTTP协议，是一个无状态协议。这意味着，全部的状态都保存在服务器端。所以，若是客户端想要操做服务器，必须经过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是创建在表现层之上的，因此就是"表现层状态转化"。
客户端用到的手段，只能是HTTP协议。具体来讲，就是HTTP协议里面，四个表示操做方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操做：GET用来获取资源，POST用来新建资源（也能够用于更新资源），PUT用来更新资源，DELETE用来删除资源。
定义：简单来讲REST是一种系统架构设计风格（而非标准），一种分布式系统的应用层解决方案。
目的：Client和Server端进一步解耦。

2、RESTful API设计指南：

一、协议

API与用户的通讯协议，老是使用HTTPs协议。

二、域名

<1>.应该尽可能将API部署在专用域名之下,(这中状况会存在跨域问题)

https://api.example.com

<2>.若是肯定API很简单，不会有进一步扩展，能够考虑放在主域名下。

https://example.org/api/

三、版本（Versioning）

应该将API的版本号放入URL。

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

另外一种作法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。

https://api.example.com/?version=v1

四、路径

路径又称"终点"（endpoint），表示API的具体网址，视网络上任何东西都是资源，均使用名词表示（可复数），在RESTful架构中，每一个网址表明一种资源（resource），因此网址中不能有动词，只能有名词，并且所用的名词每每与数据库的表格名对应。通常来讲，数据库中的表都是同种记录的"集合"（collection），因此API中的名词也应该使用复数

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

五、HTTP动词

对于资源的具体操做类型，由HTTP动词表示。

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

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

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

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

下面是一些例子。

GET /zoos：列出全部动物园
POST /zoos：新建一个动物园
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的所有信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的全部动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

六、过滤信息（Filtering）

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

下面是一些常见的参数。

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

参数的设计容许存在冗余，即容许API路径和URL参数偶尔有重复。好比，GET /zoo/ID/animals 与 GET /animals?zoo_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 - [*]：服务器发生错误，用户将没法判断发出的请求是否成功。

八、错误处理（Error handling）

若是状态码是4xx，就应该向用户返回出错信息。通常来讲，返回的信息中将error做为键名，出错信息做为键值便可。

{
    error: "Invalid API key"
}

九、返回结果

针对不一样操做，服务器向用户返回的结果应该符合如下规范。

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

十、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表示返回类型。

摘自ruanyifeng博客

3、django rest famework

• django rest framework 之 认证（一）
• django rest framework 之 权限（二）
• django rest framework 之 节流（三）
• django rest framework 之 版本（四）
• django rest framework 之 解析器（五）
• django rest framework 之 序列化（六）
• django rest framework 之 分页（七）
• django rest framework 之 视图（八）