知识预览

快速实例

Quickstart

回到顶部

序列化

创建一个序列化类

简单使用

开发我们的Web API的第一件事是为我们的Web API提供一种将代码片段实例序列化和反序列化为诸如json之类的表示形式的方式。我们可以通过声明与Django forms非常相似的序列化器（serializers）来实现。

models部分:

from django.db import models

# Create your models here.

class Book(models.Model):

    title=models.CharField(max_length=32)

    price=models.IntegerField()

    pub_date=models.DateField()

    publish=models.ForeignKey("Publish")

    authors=models.ManyToManyField("Author")

    def __str__(self):

        return self.title

class Publish(models.Model):

    name=models.CharField(max_length=32)

    email=models.EmailField()

    def __str__(self):

        return self.name

class Author(models.Model):

    name=models.CharField(max_length=32)

    age=models.IntegerField()

    def __str__(self):

        return self.name

views部分：

from rest_framework.views import APIView

from rest_framework.response import Response

from .models import *

from django.shortcuts import HttpResponse

from django.core import serializers

from rest_framework import serializers

class BookSerializers(serializers.Serializer):

    title=serializers.CharField(max_length=32)

    price=serializers.IntegerField()

    pub_date=serializers.DateField()

    publish=serializers.CharField(source="publish.name")

    #authors=serializers.CharField(source="authors.all")

    authors=serializers.SerializerMethodField()

    def get_authors(self,obj):

        temp=[]

        for author in obj.authors.all():

            temp.append(author.name)

        return temp

class BookViewSet(APIView):

    def get(self,request,*args,**kwargs):

        book_list=Book.objects.all()

        # 序列化方式1:

        # from django.forms.models import model_to_dict

        # import json

        # data=[]

        # for obj in book_list:

        #     data.append(model_to_dict(obj))

        # print(data)

        # return HttpResponse("ok")

        # 序列化方式2:

        # data=serializers.serialize("json",book_list)

        # return HttpResponse(data)

        # 序列化方式3:

        bs=BookSerializers(book_list,many=True)

        return Response(bs.data)

ModelSerializer

class BookSerializers(serializers.ModelSerializer):

      class Meta:

          model=Book

          fields="__all__"

          depth=1

提交post请求

  def post(self,request,*args,**kwargs):

        bs=BookSerializers(data=request.data,many=False)

        if bs.is_valid():

            # print(bs.validated_data)

            bs.save()

            return Response(bs.data)

        else:

            return HttpResponse(bs.errors)

重写save中的create方法

class BookSerializers(serializers.ModelSerializer):

      class Meta:

          model=Book

          fields="__all__"

          # exclude = ['authors',]

          # depth=1

      def create(self, validated_data):

          authors = validated_data.pop('authors')

          obj = Book.objects.create(**validated_data)

          obj.authors.add(*authors)

          return obj

单条数据的get和put请求

class BookDetailViewSet(APIView):

    def get(self,request,pk):

        book_obj=Book.objects.filter(pk=pk).first()

        bs=BookSerializers(book_obj)

        return Response(bs.data)

    def put(self,request,pk):

        book_obj=Book.objects.filter(pk=pk).first()

        bs=BookSerializers(book_obj,data=request.data)

        if bs.is_valid():

            bs.save()

            return Response(bs.data)

        else:

            return HttpResponse(bs.errors)

超链接API：Hyperlinked

class BookSerializers(serializers.ModelSerializer):

      publish= serializers.HyperlinkedIdentityField(
                     view_name='publish_detail',
                     lookup_field="publish_id",
                     lookup_url_kwarg="pk")

      class Meta:

          model=Book

          fields="__all__"

          #depth=1

urls部分：

urlpatterns = [

url(r'^books/$', views.BookViewSet.as_view(),name="book_list"),

url(r'^books/(?P<pk>\d+)$', views.BookDetailViewSet.as_view(),name="book_detail"),

url(r'^publishers/$', views.PublishViewSet.as_view(),name="publish_list"),

url(r'^publishers/(?P<pk>\d+)$', views.PublishDetailViewSet.as_view(),name="publish_detail"),

]

回到顶部

视图三部曲

使用混合（mixins）

上一节的视图部分：

from rest_framework.views import APIView

from rest_framework.response import Response

from .models import *

from django.shortcuts import HttpResponse

from django.core import serializers

from rest_framework import serializers

class BookSerializers(serializers.ModelSerializer):

      class Meta:

          model=Book

          fields="__all__"

          #depth=1

class PublshSerializers(serializers.ModelSerializer):

      class Meta:

          model=Publish

          fields="__all__"

          depth=1

class BookViewSet(APIView):

    def get(self,request,*args,**kwargs):

        book_list=Book.objects.all()

        bs=BookSerializers(book_list,many=True,context={'request': request})

        return Response(bs.data)

    def post(self,request,*args,**kwargs):

        print(request.data)

        bs=BookSerializers(data=request.data,many=False)

        if bs.is_valid():

            print(bs.validated_data)

            bs.save()

            return Response(bs.data)

        else:

            return HttpResponse(bs.errors)

class BookDetailViewSet(APIView):

    def get(self,request,pk):

        book_obj=Book.objects.filter(pk=pk).first()

        bs=BookSerializers(book_obj,context={'request': request})

        return Response(bs.data)

    def put(self,request,pk):

        book_obj=Book.objects.filter(pk=pk).first()

        bs=BookSerializers(book_obj,data=request.data,context={'request': request})

        if bs.is_valid():

            bs.save()

            return Response(bs.data)

        else:

            return HttpResponse(bs.errors)

class PublishViewSet(APIView):

    def get(self,request,*args,**kwargs):

        publish_list=Publish.objects.all()

        bs=PublshSerializers(publish_list,many=True,context={'request': request})

        return Response(bs.data)

    def post(self,request,*args,**kwargs):

        bs=PublshSerializers(data=request.data,many=False)

        if bs.is_valid():

            # print(bs.validated_data)

            bs.save()

            return Response(bs.data)

        else:

            return HttpResponse(bs.errors)

class PublishDetailViewSet(APIView):

    def get(self,request,pk):

        publish_obj=Publish.objects.filter(pk=pk).first()

        bs=PublshSerializers(publish_obj,context={'request': request})

        return Response(bs.data)

    def put(self,request,pk):

        publish_obj=Publish.objects.filter(pk=pk).first()

        bs=PublshSerializers(publish_obj,data=request.data,context={'request': request})

        if bs.is_valid():

            bs.save()

            return Response(bs.data)

        else:

            return HttpResponse(bs.errors)

mixin类编写视图

from rest_framework import mixins

from rest_framework import generics

class BookViewSet(mixins.ListModelMixin,

                  mixins.CreateModelMixin,

                  generics.GenericAPIView):

    queryset = Book.objects.all()

    serializer_class = BookSerializers

    def get(self, request, *args, **kwargs):

        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):

        return self.create(request, *args, **kwargs)

class BookDetailViewSet(mixins.RetrieveModelMixin,

                    mixins.UpdateModelMixin,

                    mixins.DestroyModelMixin,

                    generics.GenericAPIView):

    queryset = Book.objects.all()

    serializer_class = BookSerializers

    def get(self, request, *args, **kwargs):

        return self.retrieve(request, *args, **kwargs)

    def put(self, request, *args, **kwargs):

        return self.update(request, *args, **kwargs)

    def delete(self, request, *args, **kwargs):

        return self.destroy(request, *args, **kwargs)

使用通用的基于类的视图

通过使用mixin类，我们使用更少的代码重写了这些视图，但我们还可以再进一步。REST框架提供了一组已经混合好（mixed-in）的通用视图，我们可以使用它来简化我们的views.py模块。

from rest_framework import mixins

from rest_framework import generics

class BookViewSet(generics.ListCreateAPIView):

    queryset = Book.objects.all()

    serializer_class = BookSerializers

class BookDetailViewSet(generics.RetrieveUpdateDestroyAPIView):

    queryset = Book.objects.all()

    serializer_class = BookSerializers

class PublishViewSet(generics.ListCreateAPIView):

    queryset = Publish.objects.all()

    serializer_class = PublshSerializers

class PublishDetailViewSet(generics.RetrieveUpdateDestroyAPIView):

    queryset = Publish.objects.all()

    serializer_class = PublshSerializers

viewsets.ModelViewSet

urls.py:

    url(r'^books/$', views.BookViewSet.as_view({"get":"list","post":"create"}),name="book_list"),

    url(r'^books/(?P<pk>\d+)$', views.BookViewSet.as_view({

                'get': 'retrieve',

                'put': 'update',

                'patch': 'partial_update',

                'delete': 'destroy'

            }),name="book_detail"),

views.py:

class BookViewSet(viewsets.ModelViewSet):

    queryset = Book.objects.all()

    serializer_class = BookSerializers

回到顶部

认证与权限组件

认证组件

局部视图认证

在app01.service.auth.py:

class Authentication(BaseAuthentication):

    def authenticate(self,request):

        token=request._request.GET.get("token")

        token_obj=UserToken.objects.filter(token=token).first()

        if not token_obj:

            raise exceptions.AuthenticationFailed("验证失败!")

        return (token_obj.user,token_obj)

在views.py：

def get_random_str(user):

    import hashlib,time

    ctime=str(time.time())

    md5=hashlib.md5(bytes(user,encoding="utf8"))

    md5.update(bytes(ctime,encoding="utf8"))

    return md5.hexdigest()

from app01.service.auth import *

from django.http import JsonResponse

class LoginViewSet(APIView):

    authentication_classes = [Authentication,]

    def post(self,request,*args,**kwargs):

        res={"code":1000,"msg":None}

        try:

            user=request._request.POST.get("user")

            pwd=request._request.POST.get("pwd")

            user_obj=UserInfo.objects.filter(user=user,pwd=pwd).first()

            print(user,pwd,user_obj)

            if not user_obj:

                res["code"]=1001

                res["msg"]="用户名或者密码错误"

            else:

                token=get_random_str(user)

                UserToken.objects.update_or_create(user=user_obj,defaults={"token":token})

                res["token"]=token

        except Exception as e:

            res["code"]=1002

            res["msg"]=e

        return JsonResponse(res,json_dumps_params={"ensure_ascii":False})

全局视图认证组件

settings.py配置如下：

REST_FRAMEWORK={

"DEFAULT_AUTHENTICATION_CLASSES":["app01.service.auth.Authentication",]

}

权限组件

局部视图权限

在app01.service.permissions.py中：

from rest_framework.permissions import BasePermission

class SVIPPermission(BasePermission):

    message="SVIP才能访问!"

    def has_permission(self, request, view):

        if request.user.user_type==3:

            return True

        return False

在views.py：

from app01.service.permissions import *

class BookViewSet(generics.ListCreateAPIView):

    permission_classes = [SVIPPermission,]

    queryset = Book.objects.all()

    serializer_class = BookSerializers

全局视图权限

settings.py配置如下：

REST_FRAMEWORK={

"DEFAULT_AUTHENTICATION_CLASSES":["app01.service.auth.Authentication",],

"DEFAULT_PERMISSION_CLASSES":["app01.service.permissions.SVIPPermission",]

}

throttle(访问频率)组件

局部视图throttle

在app01.service.throttles.py中：

from rest_framework.throttling import BaseThrottle

VISIT_RECORD={}

class VisitThrottle(BaseThrottle):

    def __init__(self):

        self.history=None

    def allow_request(self,request,view):

        remote_addr = request.META.get('REMOTE_ADDR')

        print(remote_addr)

        import time

        ctime=time.time()

        if remote_addr not in VISIT_RECORD:

            VISIT_RECORD[remote_addr]=[ctime,]

            return True

        history=VISIT_RECORD.get(remote_addr)

        self.history=history

        while history and history[-1]<ctime-60:

            history.pop()

        if len(history)<3:

            history.insert(0,ctime)

            return True

        else:

            return False

    def wait(self):

        import time

        ctime=time.time()

        return 60-(ctime-self.history[-1])

在views.py中：

from app01.service.throttles import *

class BookViewSet(generics.ListCreateAPIView):

    throttle_classes = [VisitThrottle,]

    queryset = Book.objects.all()

    serializer_class = BookSerializers

全局视图throttle

REST_FRAMEWORK={

    "DEFAULT_AUTHENTICATION_CLASSES":["app01.service.auth.Authentication",],

    "DEFAULT_PERMISSION_CLASSES":["app01.service.permissions.SVIPPermission",],

    "DEFAULT_THROTTLE_CLASSES":["app01.service.throttles.VisitThrottle",]

}

内置throttle类

在app01.service.throttles.py修改为：

class VisitThrottle(SimpleRateThrottle):

    scope="visit_rate"

    def get_cache_key(self, request, view):

        return self.get_ident(request)

settings.py设置：

REST_FRAMEWORK={

    "DEFAULT_AUTHENTICATION_CLASSES":["app01.service.auth.Authentication",],

    "DEFAULT_PERMISSION_CLASSES":["app01.service.permissions.SVIPPermission",],

    "DEFAULT_THROTTLE_CLASSES":["app01.service.throttles.VisitThrottle",],

    "DEFAULT_THROTTLE_RATES":{

        "visit_rate":"5/m",

    }

}

回到顶部

解析器

request类

django的request类和rest-framework的request类的源码解析

局部视图

from rest_framework.parsers import JSONParser,FormParser

class PublishViewSet(generics.ListCreateAPIView):

    parser_classes = [FormParser,JSONParser]

    queryset = Publish.objects.all()

    serializer_class = PublshSerializers

    def post(self, request, *args, **kwargs):

        print("request.data",request.data)

        return self.create(request, *args, **kwargs)

全局视图

REST_FRAMEWORK={

    "DEFAULT_AUTHENTICATION_CLASSES":["app01.service.auth.Authentication",],

    "DEFAULT_PERMISSION_CLASSES":["app01.service.permissions.SVIPPermission",],

    "DEFAULT_THROTTLE_CLASSES":["app01.service.throttles.VisitThrottle",],

    "DEFAULT_THROTTLE_RATES":{

        "visit_rate":"5/m",

    },

    "DEFAULT_PARSER_CLASSES":['rest_framework.parsers.FormParser',]

}

回到顶部

分页

简单分页

from rest_framework.pagination import PageNumberPagination,LimitOffsetPagination

class PNPagination(PageNumberPagination):

        page_size = 1

        page_query_param = 'page'

        page_size_query_param = "size"

        max_page_size = 5

class BookViewSet(viewsets.ModelViewSet):

    queryset = Book.objects.all()

    serializer_class = BookSerializers

    def list(self,request,*args,**kwargs):

        book_list=Book.objects.all()

        pp=LimitOffsetPagination()

        pager_books=pp.paginate_queryset(queryset=book_list,request=request,view=self)

        print(pager_books)

        bs=BookSerializers(pager_books,many=True)

        #return Response(bs.data)

        return pp.get_paginated_response(bs.data)

偏移分页

from rest_framework.pagination import LimitOffsetPagination

转载

rest-framework框架的基本组件

转载：rest-framework框架的基本组件的更多相关文章

基于Django的Rest Framework框架的认证组件
0|1一.认证组件的作用在一个程序中有一些功能是需要登录才能使用的,原生Django中的auth组件可以用来解决这个认证问题,drf框架中也有对应的认证组件来解决这个问题. models.py ...
基于Django的Rest Framework框架的频率组件
0|1一.频率组件的作用在我们平常浏览网站的时候会发现,一个功能你点击很多次后,系统会让你休息会在点击,这其实就是频率控制,主要作用是限制你在一定时间内提交请求的次数,减少服务器的压力. modle ...
基于Django的Rest Framework框架的序列化组件
本文目录一 Django自带序列化组件二 rest-framework序列化之Serializer 三 rest-framework序列化之ModelSerializer 四生成hypermed ...
基于Django的Rest Framework框架的视图组件
本文目录一基本视图二 mixin类和generice类编写视图三使用generics 下ListCreateAPIView,RetrieveUpdateDestroyAPIView 四使用 ...
基于Django的Rest Framework框架的分页组件
本文目录一简单分页(查看第n页,每页显示n条) 二偏移分页(在第n个位置,向后查看n条数据) 三 CursorPagination(加密分页,只能看上一页和下一页,速度快) 回到目录一简单分 ...
Django rest framework框架中有哪些组件
认证权限(授权) 用户访问次数/频率限制版本解析器(parser) 序列化分页路由系统视图渲染器认证自定义认证的类 """ from rest_fram ...
Django Rest framework 框架之认证使用和源码执行流程
用这个框架需要先安装: pip3 install djangorestframework 如果写了一个CBV的东西,继承了View. # 继承Django里面View class APIView(Vi ...
Git.Framework 框架随手记--存储过程简化
在很多的ORM中对存储过程操作都是一个棘手的地方,因为存储过程是一段预编译的代码,其中可以包含很多处理过程.在Git.Framework中也同样存在这样的问题,目前没有能力解决这个问题.但是对于存储过 ...
Git.Framework 框架随手记--ORM条件组合
在上一篇<Git.Framework 框架随手记--ORM新增操作>中简单记录了如何对数据进行删除和修改,其用法都非常简单,在文章中提到了Where()方法,本文将详述Where() 等条 ...

随机推荐

jQuery同时监听两个事件---实现同时操控两个按键
我们都知道因为js是单线程的,所以没有可以同时触发键盘两个事件的方法今天我们就来做一个可以实现这个功能方法先来看一下成品图效果接下来我们来看下具体是怎么实现的注释写在了代码里面 <!DO ...
洛谷 P2672 推销员
题目传送门解题思路: 我们会发现本题有一个特性,就是如果我们走到一个更远的地方,那么近的地方距离原点的距离我们可以忽略. 本题要求最大的疲劳值,所以我们需要排序,第一个想到堆,反正我是先想到堆. 然 ...
合作网络（Corporative Network ）并查集+路径压缩
#include <iostream> #include <algorithm> #include <string> using namespace std; + ...
zabbix被动模式和主动模式
1 被动模式 zabbix默认采用被动模式.就是agent等待server采集数据. 在items中,type为zabbix agent就是指被动模式. 流程为:agent周期性收集数据,server ...
B. Connecting Universities DFS，无向树
http://codeforces.com/problemset/problem/700/B 题意是,在一颗树中,有k个大学,要求两两匹配,他们之间的距离作为贡献,使得距离总和最大. 一开始的时候无从 ...
Hadoop体系结构管理
一.查看Zookeeper信息 [hadoop@weekend01 ~]$zkServer.sh status JMX enabled by default Using config: /hadoop ...
猩球StarBall ,一个方便约球的小程序
扫描小程序码直接进入小程序猩球StarBall 是一款为热爱运动的人群提供便利的小程序. 开发技术为Java +Mysql 其中用到的技术框架为SpringBoot,Mybatis,Redis,Qu ...
【经验总结】OSG 安装配置
对于普通用户推荐直接下载安装包配置.如有特殊需求或想了解编译过程可参考网上文章自己编译后配置.(通常建议使用第一种方法即可) 本人安装经验: 失败:自己系统64位,VS2010 32位,开始自己动手编 ...
搭建SSM框架（聚合项目）
parents 父工程 pom base用户权限 jar wms业务 jar app帮助管理 war1. parents的pom.xml文件 1.1 maven servlet3.1.0 1.2 ...
Apache CXF 框架结构和基本原理
CXF旨在为服务创建必要的基础设施,它的整体架构主要由以下几个部分组成: 1.Bus 它是C X F架构的主干,为共享资源提供了一个可配置的场所,作用非常类似于S p r i n g的Applicat ...

转载：rest-framework框架的基本组件

快速实例

序列化

创建一个序列化类

简单使用

ModelSerializer

提交post请求

重写save中的create方法

单条数据的get和put请求

超链接API：Hyperlinked

视图三部曲

使用混合（mixins）

mixin类编写视图

使用通用的基于类的视图

viewsets.ModelViewSet

认证与权限组件

认证组件

局部视图认证

全局视图认证组件

权限组件

局部视图权限

全局视图权限

throttle(访问频率)组件

局部视图throttle

全局视图throttle

内置throttle类

解析器

request类

局部视图

全局视图

分页

简单分页

偏移分页

rest-framework框架的基本组件

转载：rest-framework框架的基本组件的更多相关文章

随机推荐

热门专题