RestFramework规范简介

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

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

1.统一的异常处理
2.API权限
3.统一的参数校验
4.缓存如何可以做的更加简单统一
5.认证
6.统一的查询过滤
7.代码分层

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

对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)

API设计规范

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

API与用户的通信协议,本质上是HTTPs协议

那么到底有哪些规范呢?

1.域名

:域名上要显示你使用了API,我们有两种方式

2.版本

我们的项目在开发过程中会进行功能的添加及优化,这个时候我们通常会为每一个版本设定一个版本号,版本号的显示也有两种方式

3.路劲

视网络上任何东西都是资源,所以路径均使用名词表示(可复数)

4.请求方式

  • GET :从服务器取出资源(一项或多项)
  • POST :在服务器新建一个资源
  • PUT :在服务器更新资源(客户端提供改变后的完整资源——全部修改)
  • PATCH :在服务器更新资源(客户端提供改变的属性——部分修改)
  • DELETE :从服务器删除资源

5.过滤
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"
}}

转自https://www.jianshu.com/p/714b20de337a

原文地址:https://www.cnblogs.com/SlookUp/p/14527970.html