为什么要使用Rest Framework？

Django REST Framework可以在Django的基础上迅速实现API，并且自身还带有WEB的测试页面，可以方便的测试自己的API。

Django REST framework 简介

序列化和反序列化可以复用
增：效验请求数据 > 执行反序列化过程 > 保存数据库 > 将保存的对象序列化并返回
删：判断要删除的数据是否存在 > 执行数据库删除
改：判断要修改的数据是否存在 > 效验请求的参数 > 执行反序列化过程 > 保存数据库 > 将保存的对象序列化并返回
查：查询数据库 > 将数据序列化并返回
特点:

1. 提供了定义序列化器Serializer的方法,可以快速根据Django ORM 或者其他库自动序列化/反序列化
2. 提供了丰富的类视图\MIXIN扩展类,简化视图的编写
3. 丰富的定制层级:函数视图\类视图\试图结合到自动生成API,满足各种需要
4. 多种身份认证和权限认证方式的支持
5. 内置了限流系统
6. 直观的API web界面
7. 可扩展性 , 插件丰富

Django rest framework核心任务

1. 多了个serializer.py文件
   这个文件的作用是Serializers把querysets和model instances这些复杂的数据结构转化为native python以便以json，xml或其他内容类型的形式render出去。
2. 视图的核心功能变了

1. 将数据库数据序列化为前端需要的格式并返回；
2. 将前端发送过来的数据反序列化为模型类型对象，并保存到数据库中。

开始Django rest framework旅程

安装第三方库

pip install django
pip install djangorestframework

配置

• 在settings.py的app中添加

INSTALLED_APPS = [
    'rest_framework', # DRF
]

创建模型类(Model)

# 栏目
class Column(models.Model):
    name = models.CharField(max_length=20, unique=True, verbose_name='栏目')
    link_url = models.URLField(verbose_name= '链接')
    index = models.IntegerField(verbose_name='位置')

    class Meta:  # 模型元选项
        db_table = 'tb_column'   # 在数据库中的表名，否则Django自动生成为app名字_类名
        ordering = ['index']
        verbose_name = '栏目'
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.name

创建一个序列化类(Serializer)

在app目录下新建serializer.py

from rest_framework import serializers
from article.models import Column

class ColumnSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=20, label='栏目')
    link_url = serializers.URLField(label= '链接')
    index = serializers.IntegerField(label='位置')


    def create(self, validated_data): # create()和update()方法定义了在调用serializer.save()时成熟的实例是如何被创建和修改的。
        return Column.objects.create(**validated_data)

    def update(self, instance, validated_data):
        instance.name = validated_data.get('name', instance.name)
        instance.link_url = validated_data.get('link_url', instance.link_url)
        instance.index = validated_data.get('index', instance.index)
        instance.save()
        return instance

注意
各字段与模型类中的字段是否一致。

编写视图(APIView)

from article.models import Column
from .serializers import ColumnSerializer
from rest_framework.views import APIView
from rest_framework.response import Response


class ColumnView(APIView):
    def get(self, request):
        # 获取queryset
        columns = Column.objects.all()
        # 开始序列化；
        serializer_data = ColumnSerializer(columns, many=True)

        #print(serializer_data)

        # print(serializer_data.data)

        # 获取序列化后的数据，返回给客户端
        return Response(serializer_data.data)

    def post(self, request):
        # 获取数据
        client_data = request.data

        # 序列化数据
        verified_data = ColumnSerializer(data=client_data)
        #print(verified_data)

        # 校验数据
        if verified_data.is_valid():
            column = verified_data.save()
            #print(verified_data.data) # 需要保存之后才能获取.data
            return Response(verified_data.data)
        else:
            return Response(verified_data.errors, status=400)
    
      
     def put(self, request, column_id):
           column_obj =  Column.objects.get(pk=column_id)
           verified_data = ColumnSerializer(instance=column_obj , data=request.data)
            # 校验数据
            if verified_data.is_valid():
                column = verified_data.save()
                #print(verified_data.data) # 需要保存之后才能获取.data
                return Response(verified_data.data)
            else:
                return Response(verified_data.errors, status=400)
              
      def delete(self, request, column_id):
            column_obj =  Column.objects.get(pk=column_id)
            column_obj.delete()
            return Response({'message': 'OK'})                
           
            

配置URL地址

app_name = 'api'
urlpatterns = [
      path('column/', ColumnView.as_view(), name='column'),
]

利用postman测试

get获取数据列表信息

image.png

get方法中两个输出语句为

image.png

image.png

输出语句

image.png

我们将视图修改下，获取单个数据

image.png

image.png

由以上可以看出API与我们的表单(forms)很相似，除了将模型实例(model instance)序列化外，我们也能序列化查询集(querysets)，只需要添加一个序列化参数many=True。

使用模型序列化ModelSerializers

我们定义的ColumnSerializer类字段和模型字段有很多是重复的，为了保证代码简洁，减少重复， 我们可以类似于Django提供表单(Form)类和模型表单(ModelForm)类相同的方式，REST framework也提供了Serializer和ModelSerializer。下面我们重写ColumnSerializer类。

class ColumnSerializer(serializers.ModelSerializer):
    class Meta:
        model = Column
        fields = ['name', 'link_url', 'index']

测试结果和使用

image.png