rest-framework框架学习之基本组件

最新推荐文章于 2020-06-20 14:09:34 发布
最新推荐文章于 2020-06-20 14:09:34 发布
阅读量368 收藏
点赞数
分类专栏： python Django
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010525694/article/details/82700283
版权

先放document： http://www.django-rest-framework.org/tutorial/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

使用原始CBV
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)
使用mixins
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

views.py

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializers

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"),

认证与权限组件

认证组件

局部视图认证

在app01.service.auth.py:

from rest_framework.authentication import BaseAuthentication

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",
    }
}

解析器

局部视图

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)

https://blog.csdn.net/l_vip/article/details/79156113
https://github.com/jianshijiuyou/django-rest-framework-api-guide
https://www.cnblogs.com/wupeiqi/articles/7805382.html
https://blog.csdn.net/l_vip/article/details/79142105

django-rest 重写ModelViewSet中的create方法
ttxs2016的博客
03-20 1万+
实现基本功能，网页上post一张图片（字段name,image），存入re_photo表，使用字段name在worker表（字段name,number,gender,job,photo）中做查询,匹配出具有相同name的两张图片做识别class RecognitionViewSet(viewsets.ModelViewSet): queryset = re_photo.objects.al...
DRF Django rest framework 快捷添加field的几种方式
程序圆圆圆
06-10 1228
fields = ('a', 'b', 'c') fields = '__all__' exclude = ('users',) read_only_fields = ('account_name',) extra_kwargs = {'password': {'write_only': True}} class AccountSerializer(serializers.ModelSeria...
Django REST framework 中文乱码问题，将json输出字符强制为utf-8编码
hj009zzh的博客
03-25 1744
参考文档 https://blog.csdn.net/Odyssues_lee/article/details/80895128 https://blog.csdn.net/hudongcun/article/details/87874991 1.根因 页面上出现乱码，通常是Content-Type 配置的问题，指定charset=utf-8一般都会解决 2.DRF 2.1 乱码问题 如下图，用d...
Django REST framework 简介
Odyssues_lee的博客
07-03 1347
Django REST framework 简介在序列化与反序列化时，虽然操作的数据不尽相同，但是执行的过程却是相似的，也就是说这部分代码是可以复用简化编写的。在开发REST API的视图中，虽然每个视图具体操作的数据不同，但增、删、改、查的实现流程基本套路化，所以这部分代码也是可以复用简化编写的：增：校验请求数据 -&gt; 执行反序列化过程 -&gt; 保存数据库 -&gt; 将保存的对象序列...
restframework（一）
小白
05-22 7095
restframework restframework是django对restful架构扩展的第三方库 restful架构 主要原则 网络上的所有事物都被抽象成为资源 每个资源都有唯一的资源标识符 同一个资源具有多种表现形式（xml， json等） 对资源的各种操作不会修改资源标识符 所有操作均是无状态的 符合REST原则的架构 什么是restful 对应的中文是res...
以 `Python` 语言，采用 django-rest-framework 框架实现后端API开发.zip
03-03
在本项目中，我们主要探讨如何使用Python编程语言与Django REST ...这个压缩包可能包含了整个项目的源代码，包括模型定义、序列化器、视图、路由配置以及其他相关组件，是学习和实践Django REST Framework的好材料。
Django-REST-framework教程中文版
09-12
Django-REST-framework是一个建立在Django框架之上的强大的REST API工具包，它允许开发者利用Django的各种组件快速构建Web服务API。本教程基于Django1.9以及restframework-v3.3.3版本，着重介绍了序列化、请求和响应...
djangochannelsrestframework：使用Django channel-v3的websocket的Rest-framework
02-04
**Django Channels v3 和 REST Framework 的...通过这个项目，开发者可以学习到如何利用 Django Channels 和 REST Framework 构建实时的、交互性强的 Web 应用程序，比如在线聊天、实时股票报价或者多人游戏等场景。
django-rest-framework：aprendendo django rest框架
02-13
通过学习和实践使用Django REST Framework，开发者可以构建出功能强大、易于维护的API，满足各种Web服务的需求。无论你是初学者还是经验丰富的开发者，DRF都提供了一套完善的工具，帮助你在Python的世界里构建出出色...
Python在线考试系统后端-大学毕业设计-基于Django+Django -Rest-Framework.zip
02-23
本文将深入探讨一个基于Python的在线考试系统后端的实现，该系统利用了强大的Django框架以及Django Rest-Framework来构建RESTful API接口。Django是Python领域内广泛应用的Web开发框架，而Django Rest-Framework则为...
rest_framework框架的认识
weixin_30938149的博客
07-04 809
rest_framework框架的认识 　　它是基于Django的，帮助我们快速开发符合RESTful规范的接口框架。 一 路由 　　可以通过路由as_view()传参 根据请求方式的不同执行对应不同的方法 　　在routers模块下 封装了很多关于路由的方法 ， 最基础的BaseRouter类，给我提供自定制的接口。 　　下面这个方法给我们提...
Django REST framework的各种技巧——1.基础讲解
王冠hurt的博客
01-20 1万+
写在最上面的话 django是一个神奇的框架，而restframework又是遵循了这个框架的另一个神奇的框架，然而由于restframework的文档稀烂无比，很多时候你必须看源码才能写出科学的代码，这挡住了很多新手的路。 要用好restframework你必须对django或者说python的几个概念有比较深刻的理解，GenericView，Mixin，子类父类集成调用，多继承时的
Django REST framework 的快速入门教程
ppppfly的专栏
04-07 1万+
快速教程我们将创建一个简单的API，让管理员用户能查看，修改系统中的用户和组。项目搭建创建一个新的Django项目，叫做 tutorial，然后开始一个新的app叫做 quickstart。# 创建项目的目录 mkdir tutorial cd tutorial# 创建一个虚拟环境（virtualenv），来隔离地搭依赖包（开发环境） virtualenv env source env/bin/ac
django rest framework serializers小结
热门推荐
l_vip的博客
01-24 3万+
引言 　　serializers是什么？官网是这样的”Serializers allow complex data such as querysets and model instances to be converted to native Python datatypes that can then be easily rendered into JSON, XML or other
Django REST framework学习笔记
NiuXL的编程技术网络日志
06-20 696
文章目录1. API接口开发1.1 获取数据的接口1.2 添加数据的接口1.3 更新数据的接口1.4 删除数据的接口2. API字段的定制2.1 别名字段2.2 字段格式化2.3 字段创建2.4 字段加工3. DRF认证3.1 自定义认证3.2 认证流程3.3 全局配置认证3.4 匿名用户配置3.5 内置基本认证4. DRF权限4.1 权限的基本使用4.2 权限源码流程4.3 全局权限配置4.4 内置权限类5. 访问频率控制/节流5.1 访问频率控制基本实现5.2 访问频率控制源码流程5.3 访问频率全局.
使用REST-Framework做Django后端接口
菜鸟的博客
09-08 365
创建虚拟环境 python3 -m venv env source env/bin/activate 下载依赖 pip install django pip install djangorestframework pip install pyments 开始 创建app python manage.py startapp snippets 添加app到settings.py INSTALLE...
python django rest framework 快速入门
菜鸟阿达
11-03 1314
创建项目1.使用ide开发工具创建项目 或 2. 使用命令添加数据库配置DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': "my_db", 'USER': "root", 'PASSWORD': "", 'HOST
python django rest framework Serialization 的学习
菜鸟阿达
11-03 424
创建一个新的apppython manage.py startapp snippets修改settings文件注意:使用Django <1.9，则需要用snippets替换snippets.apps.SnippetsConfig。INSTALLED_APPS = ( ... 'rest_framework', 'snippets.apps.SnippetsConfig', )
继续深入REST-Framework
菜鸟的博客
09-08 316
Request object REST framework提供了Request对象。其中提供一个属性request.data很有用 Response object REST framework提供一个Response对象，提供一个返回模板TemplateResponse API views @api_view能够让request，response是REST framework CODE @ap...
后端框架：django-rest-framework是什么
最新发布
07-25
Django REST Framework (DRF) 是一套用于构建高效、功能丰富的 API 的 Python 框架。它是基于 Django Web 应用框架的一个独立组件，并提供了一系列工具和服务，旨在简化 API 开发过程。 ### 功能特点： #### 简化 API 创建： - DRF 提供了一套完整的、易于使用的 API 创建工具，包括认证、权限控制、序列化和分页等功能。 - 可以快速生成 CRUD（创建、读取、更新、删除）操作所需的视图和序列化器，降低了开发成本和提高了开发效率。 #### 高度自定义性： - DRF 允许开发者高度定制 API 行为，包括路由配置、错误处理、响应渲染等。 - 支持多种验证机制和权限系统，使得安全性得到保障。 #### 易于集成： - 它可以与 Django 无缝集成，也可以作为一个独立项目与其他框架配合工作，如 Flask 或 FastAPI。 - 提供了丰富的文档和示例，便于学习和使用。 #### 强大的功能集： - **模型绑定**：自动将数据模型映射到 API 资源上，简化数据管理。 - **序列化与反序列化**：强大的序列化能力允许轻松转换数据格式，并支持 JSON、XML 等多种格式。 - **动态路由**：可以根据需要动态生成和修改路由，增加灵活性。 - **过滤与排序**：提供丰富的方式对查询结果进行过滤和排序，提升用户体验。 ### 示例使用场景： - 开发需要大量数据交互的应用程序，例如电子商务平台、社交媒体应用、企业管理系统等，特别是当需要对外提供 RESTful 格式的 API 接口时。 ### 相关问题： 1. Django REST Framework 与其他后端框架相比有何优势？ 2. 如何开始使用 Django REST Framework 开发自己的 API？ 3. Django REST Framework 中如何实现更复杂的数据处理逻辑？
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值