django rest_framework开发十大规范

2019独角兽企业重金招聘Python工程师标准>>>

 rest_framework 安装：

pip3 install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host=pypi.douban.com

 

一：什么是restful?(软件架构风格)

• REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
• REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
• 所有的数据，不管是通过网络获取的还是操作数据库获得（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
• 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）
  • 对互联网上的任意东西都视为资源，他认为一个url就是一个资源 比如：http://www.xxx.com/get_user/

2 什么是api

是一个接口，通过他能实现前后端分离。前端使用vue 发送ajax请求（axios）

 

3 RESTful API设计 

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。

因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。

4 django restframework框架规范：

一：协议：   api与用户之间的协议，总是要用https协议完成  

二：域名：  尽量将api布置在主域名上。

      1 https:// api.example.com    这种可能存在跨域问题，也就是同源（域名，端口，协议），

     解决方法：判断是简单请求还是复杂请求，简单请求想get，直接("Access-Control-Allow-Origin:http://www.xxx.com")，如果是复杂请求，浏览器会先给options，然后在浏览器里面加上相对应的access那段。

 

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

三;版本，应该讲把api版本号（v1）放到url中：

     1  htttps://api.example.com/v1/ 

四：路径

路径又称"终点"（endpoint），表示API的具体网址。

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

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

 

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

五：提交方式（method）

GET:从浏览器去除资源（一或多条数据）

POST：从浏览器新增资源

PUT:在服务器更新资源（客户端提供改变后的完整资源）

PUTCH:在服务器更新资源（客户端提供改变后的属性）

DELETE:在服务器删除资源

下面是具体的：

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

六：过滤：

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

七：状态码

更多详情：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

八：返回错误信息，如果是4位状态码就是错误的，把错误信息当做key

def get(self,request,*args,**kwargs):
    ret = {
        'code':1000,
        'msg':'xxx'
    }
    # return HttpResponse(json.dumps(ret))
    return HttpResponse(json.dumps(ret), status=201)

• 错误处理，状态码是4xx时，应返回错误信息，error当做key。

1 2 3

{     error: "Invalid API key" }

 

 

九：

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

 

 

十：

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

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

{"link": {
  "rel":   "collection https://www.example.com/zoos",  #表示这个API与当前网址的关系（collection关系，并给出该collection的网址）
  "href":  "https://api.example.com/zoos",  #API路径
  "title": "List of zoos",  #API的标题
  "type":  "application/vnd.yourformat+json"  #返回类型
}}

Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。

{
  "current_user_url": "https://api.github.com/user",
  "authorizations_url": "https://api.github.com/authorizations",
  // ...
}

从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

 

 

最后概括：

Django生命周期概括:

    前端发送请求-->Django的wsgi-->中间件-->路由系统-->视图-->ORM数据库操作-->模板-->返回数据给用户

rest framework生命周期：

    前端发送请求-->Django的wsgi-->中间件-->路由系统_执行CBV的as_view()，就是执行内部的dispath方法-->在执行dispath之前，有版本分析 和 渲染器-->在dispath内，对request封装-->版本-->认证-->权限-->限流-->视图-->如果视图用到缓存( request.data or   request.query_params )就用到了 解析器-->视图处理数据，用到了序列化(对数据进行序列化或验证) -->视图返回数据可以用到分页

 

 

 

 

转载于:https://my.oschina.net/u/3648651/blog/1839407