Django Rest Framework

一、什么是RESTful

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

二、RESTful API设计

  • API与用户的通信协议，总是使用HTTPs协议。
  • 域名
    • https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
    • https://example.org/api/                        API很简单
  • 版本
    • URL，如：https://api.example.com/v1/
    • 请求头                                                  跨域时，引发发送多次请求
  • 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
    • https://api.example.com/v1/employees
  • method
    • GET：从服务器取出资源（一项或多项）
    • POST：在服务器新建一个资源
    • PUT：在服务器更新资源（客户端提供改变后的完整资源）
    • PATCH：在服务器更新资源（客户端提供改变的属性）
    • DELETE：从服务器删除资源
  • 过滤，通过在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：指定筛选条件
  • 状态码
　　 
 1 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
 2 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
 3 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
 4 NO CONTENT - [DELETE]：用户删除数据成功。
 5 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
 6 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
 7 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
 8 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
 9 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
10 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
11 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
12 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
13 
14 更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.ht
  • 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
  • 错误处理，状态码是4xx时，应返回错误信息，error当做key
1 {
2     error: "Invalid API key"
3 }

 

  • 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范。
1 GET /collection：返回资源对象的列表（数组）
2 GET /collection/resource：返回单个资源对象
3 POST /collection：返回新生成的资源对象
4 PUT /collection/resource：返回完整的资源对象
5 PATCH /collection/resource：返回完整的资源对象
6 DELETE /collection/resource：返回一个空文档
  • Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
1 {"link": {
2   "rel":   "collection https://www.example.com/zoos",
3   "href":  "https://api.example.com/zoos",
4   "title": "List of zoos",
5   "type":  "application/vnd.yourformat+json"
6 }}

三、基于Django的实现

路由系统：

1 urlpatterns = [
2     url(r'^users', Users.as_view()),
3 ]

CBV试图:

 1 from django.views import View
 2 from django.http import JsonResponse
 3  
 4 class Users(View):
 5     def get(self, request, *args, **kwargs):
 6         result = {
 7             'status': True,
 8             'data': 'response data'
 9         }
10         return JsonResponse(result, status=200)
11  
12     def post(self, request, *args, **kwargs):
13         result = {
14             'status': True,
15             'data': 'response data'
16         }
17         return JsonResponse(result, status=200)

四、基于Django Rest Framework框架实现

url.py

1 from django.conf.urls import url, include
2 from web.views.s1_api import TestView
3  
4 urlpatterns = [
5     url(r'^test/', TestView.as_view()),
6 ]

views.py

 1 from rest_framework.views import APIView
 2 from rest_framework.response import Response
 3  
 4  
 5 class TestView(APIView):
 6     def dispatch(self, request, *args, **kwargs):
 7         """
 8         请求到来之后，都要执行dispatch方法，dispatch方法根据请求方式不同触发 get/post/put等方法
 9          
10         注意：APIView中的dispatch方法有好多好多的功能
11         """
12         return super().dispatch(request, *args, **kwargs)
13  
14     def get(self, request, *args, **kwargs):
15         return Response('GET请求，响应内容')
16  
17     def post(self, request, *args, **kwargs):
18         return Response('POST请求，响应内容')
19  
20     def put(self, request, *args, **kwargs):
21         return Response('PUT请求，响应内容')

上述是rest framework框架基本流程，重要的功能是在APIView的dispatch中触发。

参考文档：http://www.cnblogs.com/wupeiqi/articles/7805382.html

posted @ 2019-03-14 10:21  苦行僧PH  阅读(182)  评论(0)  编辑  收藏  举报