Rest framework框架的使用

安装和配置

用pip命令进行安装:

pip3 install djangorestframework
pip install markdown

安装完毕后，还需要在Django的settings.py中做如下配置:

#settings.py
INSTALLED_APPS = [
    ...
    'rest_framework',
]

解析器

一般情况下，Django的请求体带参数时，数据会存储在request.body中。但是，只有当请求体的Content-Type值为 'application/x-www-form-urlencoded'时，且数据的格式是类似'name=xxx&age=19&key=value'这种形式的情况下，Django内置的解析器才会将request.body中的参数解析成QueryDict，存储到request.POST这个对象中。

而rest_framework的解析器，可以对请求体数据的类型进行了扩展。比如，我们想解析请求体中Content-Type= application/json的JSON格式数据，则可以参考如下代码：

#views.py

from rest_framework.parsers import JSONParser,FormParser

class ParserView(APIView):
    parser_classes = [JSONParser,FormParser]
    def post(self,request,*args,**kwargs):
        print(request.data)

如果需要全局应用某解析器，可以在settings.py中的rest_framework全局变量中进行设置：

#settings.py

REST_FRAMEWORK = {
    # 指定用于全局的解析器列表
    'DEFAULT_PARSER_CLASSES': ['rest_framework.parsers.JSONParser','rest_framework.parsers.FormParser'],
}

序列化

序列化器的作用，是将model查询出的queryset对象进行序列号，产生前端可以识别的Json对象。

一般我们会在对应app目录下，也即与models.py同级的路径下创建一个文件serializers.py用于编写序列话器，我们接下来编写一下上述UserInfo的序列化器：

#users/serializers.py

from rest_framework import serializers
from .models import UserInfo,UserToken


class UserInfoSerializer(serializers.ModelSerializer):
    #自定义字段，source表示该字段绑定model中的字段
    user_type_display = serializers.CharField(source='get_user_type_display')
    class Meta:
        #fields = "__all__"表示选择model中的所有字段
        fields = ('user_type','user_type_display','nick_name',
                  'birday','gender','address','email','mobile','image','username','is_active','create_time')
        model = UserInfo
        

class UserTokenSerializer(serializers.ModelSerializer):
    #自定义字段，source表示该字段绑定model中的字段
    username = serializers.CharField(source='user.username')
    #自定义显示,允许自定义函数的方式生产返回字段内容
    urls = serializers.SerializerMethodField()
    
    def get_rls(self,row):
      return []
    
    class Meta:
        fields = ('username', 'token','create_time','user')
        model = UserToken
        #如果需求把该对象的子对象显示出来，可以设置这个参数
        depth = 1

由于UserToken和UserInfo有外键关联关系，所以在UserTokenSerializer中可以引用UserInfo的字段。

视图

rest_framework框架提供了一个APIView视图的接口，在views.py中可以将model查询出的queryset对象，使用对应的序列化器进行序列化后返回：

#views.py
from rest_framework.views import APIView
from rest_framework.response import Response
from . import models
from . import serializers


class UserInfoView(APIView):
    def get(self,request,*args,**kwargs):
        user = models.UserInfo.objects.get(username=request.GET.get('username'))
        ser = serializers.UserInfoSerializer(instance=user)
        return Response(ser.data, status=200)

class UserTokenView(APIView):
    def get(self,request,*args,**kwargs):
        user = models.UserInfo.objects.get(username=request.GET.get('username'))
        usertokens = models.UserToken.objects.filter(user=user).all()
        ser = serializers.UserTokenSerializer(instance=usertokens,many=True)
        return Response(ser.data, status=200)

coreapi文档

一个生成自动接口文档页面的工具，配置如下：

#settings.py

REST_FRAMEWORK = {
    # 指定用于支持coreapi的Schema
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

然后，urls.py文档添加如下内容即可使用:

from rest_framework.documentation import include_docs_urls

...
urlpatterns = [
...
    url(r'^docs/',include_docs_urls(title="API测试文档"))
]