第八单元 DRF框架及APIView-CFANZ编程社区

前后端分离

前：浏览器
- HTML、CSS、Bootstrap、JS、JQuery、Vue、NodeJS、webpack
- 体验为主：炫酷、流畅、兼容
后：服务端
- Jvm、springboot、Django、flask、tornado、
- 三高：高并发、高可用、高性能

传统的不分离：业务耦合较强、指责划分不明确、开发成本较高、服务器压力较大、提高 SEO 速度，提高搜索引擎收录检索速度

前后端分离：部署解耦、业务划分清晰，职责更为明确、开发成本较低，一套后台可以支持多套前端渲染、SEO 优化较差，需要引入一些页面静态化手段

restful风格

RestFul 规范建议

1.域名要有标示

https://api.baidu.com或https://baidu.com/api/

2.路由中体现接口版本号

https://api.baidu.com/v1/
https://baidu.com/api/v1/
http://openapi.tuling123.com/openapi/api/v2

3.使用合理的请求方式

GET：获取数据
POST：提交数据，创建数据
PUT：提交数据，更新数据
DELETE：删除数据
PATCH：在服务器更新(更新)资源
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的

4.提供参数过滤数据

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

5.使用合理的状态码

200 OK - [GET] # 服务器成功返回用户请求的数据
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 - [*] # 服务器发生错误，用户将无法判断发出的请求是否成功

什么是接口及接口文档

API，全称是Application Programming Interface，即应用程序编程接口，我们日常中习惯简称为“接口”。其实，接口这个词大家应该不会陌生，比如我们平时比较常用的“USB接口”，就是用来存储和传输数据用的；

API接口文档一般分为接口描述、接口地址、请求方法、请求参数、响应内容、错误代码、实例几个部分：

DRF工程

安装DRF框架

pip install djangorestframework

配置 settings

需要在settings内注册
INSTALLED_APPS = [
  ...
  'rest_framework',
]

APIView

.data

# 是用来获取表单或json提交的数据、对POST、PUT、PATCH请求方式解析后的数据
from rest_framework.views import APIView
class ExampleView(APIView):
  def post(self, request):
      data = request.data # json/form 提交的数据
      return Response({'received data': request.data})

.query_params

# 获取get请求传输的数据
from rest_framework.views import APIView
class ExampleView(APIView):
    def get(self, request):
        data = request.query_params # get 的连接传参
        return Response({'received data': request.query_params})

视图的Response及json处理

Response(data=None, status=None, template_name=None, headers=None, exception=False, content_type=None)
'''
data: 需要返回的数据，data的数据不能是复杂的需要经过序列化的方式才能返回
status: 状态码
headers: 头部信息
content-type: 返回数据 MIME 类型,一般不要多余设置，drf 会自动根据数据进行设置
'''

常见状态码及Response的状态码处理

200 OK - [GET] # 服务器成功返回用户请求的数据
201 CREATED - [POST/PUT/PATCH] # 用户新建或修改数据成功。
202 Accepted - [*] # 表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE] # 用户删除数据成功。

序列化

序列化：就是把模型层的数据返回为JSON**数据集

反序列化：就是把前端发来的JSON**数据，类字典数据，变为模型层的数据

DRF的序列化器

先创建序列化的py文件
# 创建自己的序列化器---写模型类一样
from rest_framework import serializers
# 定义序列化器的名字
class TeacherSerializer(serializers.Serializer):
    name = serializers.CharField()
    age = serializers.IntegerField()
    gender = serializers.CharField()

序列化器的使用

先导入序列化器
from myapp.serializers import PeopleSerializer

class MyView(APIView):
    def get(self,request):
        people = People.objects.all()
        # people是要序列化的数据，many=True多个数据、单个数据无需many
        ser = PeopleSerializer(people,many=True)
        return Response(ser.data,status=200)