RestFramework——API设计规范

 

what's the RESTful

　　RestFramework是一个能快速为咱们提供API接口，方便咱们编程的框架。API是后端编程人员写的，为了让前端拿数据的一个接口，一般就是以url的形式存在。

　　每一个项目总有第一我的作基础构架，这个时候就不是仅仅实现一个API就OK了，须要考虑更多的事情，包括

• • 　　统一的异常处理

  • 　　API权限

  • 　　统一的参数校验

  • 　　缓存如何能够作的更简单统一

  • 　　认证

  • 　　统一的查询过滤

  • 　　代码分层

RestFramework能很好的帮咱们作这些事情。

了解RestFramework以前咱们首先要知道什么是REST：

• REST是一种标准，restful是一种规范，根据产品需求须要定出一份方便先后端的规范，与协议（如HTTP协议）不一样，不是全部的标准要求都须要遵循。
• REST与技术无关，表明的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
• REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源经过URL进行标识，客户端应用经过URL来获取资源的表征，得到这些表征导致这些应用转变状态
• 全部的数据，不过是经过网络获取的仍是操做（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其余架构风格的最本质属性
• 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

 

API设计规范

　　首先咱们要知道，API并非必须的，若是整个项目只有你一我的或者不多的人完成，彻底能够直接用Django的模板引擎渲染发送到前端后直接操做。API的使用主要是为了解决多人开发，特别是先后端分离的状况。由于前端人员在制做页面时必然会须要向后端要数据，可是假如先后端是分离的，就不能用Django的render了，大部分状况前端会用ajax发送请求，后端人员则发送JSON字符串给前端，前端再反序列化后进行使用。这个时候其实咱们设计一套API出来，就能使咱们的任务轻松不少。因此，RestFramework就应运而生了。

　　API与用户的通讯协议，本质上是HTTPs协议。

使用RestFramework设计API有一套规范，即RESTful，为了避免平添与你合做开发的人的烦恼，咱们仍是要遵循这些规范。那么到底有哪些规范呢？

1. 域名：域名上要显示你使用了API，咱们有两种方式
   • https://api.example.com                  方式一：将API部署在专用域名上（是官网的推荐方式，但这么作会存在跨域问题）
   • https://example.org/api/                  方式二： 写在路径上，API很简单
2. 版本：咱们的项目在开发过程当中会进行功能的添加及优化，这个时候咱们一般会为每个版本设定一个版本号，版本号的显示也有两种方式
   • https://api.example.com/v1/　　     方式一： 写在路径上，API很简单
   • https://v1.example.com                   方式二：将版本号部署在专用域名上（一样会存在跨域问题， 跨域时会引起发送屡次请求）
3. 路径：视网络上任何东西都是资源，因此路径均使用名词表示（可复数）
   • https://api.example.com/v1/zoos
   • https://api.example.com/v1/animals
4. 请求方式：
   • GET      ：从服务器取出资源（一项或多项）
   • POST    ：在服务器新建一个资源
   • PUT      ：在服务器更新资源（客户端提供改变后的完整资源——所有修改）
   • PATCH  ：在服务器更新资源（客户端提供改变的属性——部分修改）
   • DELETE ：从服务器删除资源
5. 过滤：经过在URL上传参的方式，有GET请求获取相应的数据
   • 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. 状态码：咱们能够经过状态码来判断请求的状态，以处理相应的请求。在状态码是4开头时，应该捕捉相应错误并返回错误信息

   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

   经常使用状态码

   {error: "Invalid API key"}#错误信息因用error做为key

7. 返回结果：针对不一样操做，服务器向用户返回的结果应该符合如下规范。
   • GET/collection：返回资源对象的列表
   • GET/collection/resource：返回单个资源对象
   • POST/collection：返回新生成的资源对象
   • PUT/collection/resource：返回完整的资源对象
   • PATCH/collection/resource：返回完整的资源对象
   • DELETE/collection/resource：返回一个空文档
   • 　
8. 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" }}