Django的DRF（二）：APIView(一级视图)、GenericAPIView(二级视图)、三级视图、ViewSets(视图集)、Router(路由)

最新推荐文章于 2024-03-06 13:27:27 发布
最新推荐文章于 2024-03-06 13:27:27 发布
阅读量2.9k 收藏 32
点赞数 3
分类专栏： Django基础知识 文章标签： python django APIView
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yuanfate/article/details/108592679
版权

文章目录

一.APIView(一级视图)

DRF的APIViews官网：https://www.django-rest-framework.org/api-guide/views/
APIView是REST framework提供的所有视图的基类，继承自Django的View父类。

APIViews的特点：
1）集成自View 　　　　　　　　　　2）提供了自己的request对象
3）提供了自己的response对象　　　　4）提供了认证，权限，限流等功能

1.Request与Response

（1）Request
REST framework 传入视图的request对象不再是Django默认的HttpRequest对象，而是REST framework提供的扩展了HttpRequest类的Request类的对象。

REST framework 提供了Parser解析器，在接收到请求后会自动根据Content-Type指明的请求数据类型（如JSON、表单等）将请求数据进行parse解析，解析为类字典对象保存到Request对象中。

Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。

无论前端发送的哪种格式的数据，我们都可以以统一的方式读取数据。
常用属性：
1）.query_params
request.query_params与Django标准的request.GET相同，只是更换了更正确的名称而已。
2）.data
request.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性，但提供如下特性：
　　包含了解析之后的文件和非文件数据
　　包含了对POST、PUT、PATCH请求方式解析后的数据
　　利用了REST framework的parsers解析器，不仅支持表单类型数据，也支持JSON数据
示例：
view.py:

# 定义类，集成APIView
from django.http import HttpResponse
from rest_framework.views import APIView

class BookAPIView(APIView):
    def get(self, request):
        # 获取APIView中的get请求参数
        print(request.query_params)
        return HttpResponse('get')
    def post(self,request):
        # 获取APIView中的post请求参数
        print(request.data)
        return HttpResponse('post')

子路由：

from django.conf.urls import url
from . import views
urlpatterns = [
    url(r'^books/$',views.BookAPIView.as_view())
]

根路由：

url(r'^', include('Book.urls'))

运行结果：
在这里插入图片描述

在这里插入图片描述
（2）Response
REST framework提供了一个响应类Response，使用该类构造响应对象时，响应的具体数据内容会被转换（render渲染）成符合前端需求的类型。
构造方式：

Response(data, status=None, template_name=None, headers=None, content_type=None)

data数据不要是render处理之后的数据，只需传递python的内建类型数据即可，REST framework会使用renderer渲染器处理data。

data不能是复杂结构的数据，如Django的模型类对象，对于这样的数据我们可以使用Serializer序列化器序列化处理后（转为了Python字典类型）再传递给data参数。

参数说明:
　　data: 为响应准备的序列化处理后的数据；
　　status: 状态码，默认200；
　　template_name: 模板名称，如果使用HTMLRenderer 时需指明；
　　headers: 用于存放响应头信息的字典；
　　content_type: 响应数据的Content-Type，通常此参数无需传递，REST framework会根据前端所需类型数据来设置该参数。
示例：

from rest_framework import status
from rest_framework.response import Response
from rest_framework.views import APIView

class BookAPIView(APIView):
    def get(self, request):
        return Response([{'name':'YFater'},{'age':18}],status=status.HTTP_200_OK)

运行结果：
在这里插入图片描述

使用Response的好处：
1.使用一个类，就可以替代View中的各种类型的Response（HTTPResponse，JsonResponse…）
2.可以配合状态码status使用

（3）状态码
为了方便设置状态码，REST framewrok在rest_framework.status模块中提供了常用状态码常量。
1）信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
2）成功 - 2xx
HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS
3）重定向 - 3xx
HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT
4）客户端错误 - 4xx
HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
5）服务器错误 - 5xx
HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED

2.APIView实现列表视图

serializers.py:

from rest_framework import serializers
from Book.models import BookInfo

# 定义书籍模型序列化器
class BookInfoModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo,
        fields = '__all__'

view.py:

# 序列化器和APIView实现列表视图
class BookListAPIView(APIView):
    def get(self,request):
        # 查询所有的书籍
        books = BookInfo.objects.all()
        # 将对象列表转换成字典列表
        serializer = BookInfoModelSerializer(instance=books,many=True)
        # 返回响应
        return Response(serializer.data)

    def post(self,request):
        # 获取参数
        data_dict = request.data
        # 创建序列化器
        serializer = BookInfoModelSerializer(data=data_dict)
        # 校验
        serializer.is_valid(raise_exception=True)
        # 入库
        serializer.save()
        # 返回响应
        return Response(serializer.data,status=status.HTTP_201_CREATED)

子路由：

url(r'^books/$',views.BookListAPIView.as_view()),

运行结果：
在这里插入图片描述
在这里插入图片描述

3.APIView实现详情视图

views.py:

# 序列化器和APIView实现详情视图
class BookDetailAPIView(APIView):
    def get(self,request,book_id):
        #1 获取书籍
        book = BookInfo.objects.get(pk=book_id)
        #2 创建序列化对象
        serializer = BookInfoModelSerializer(instance=book)
        #3 返回响应
        return Response(serializer.data,status=status.HTTP_200_OK)
    def put(self,request,book_id):
        # 获取数据，获取对象
        dict_data = request.data
        book = BookInfo.objects.get(pk=book_id)
        # 创建序列化对象
        serializer = BookInfoModelSerializer(instance=book,data=dict_data)
        # 校验，入库
        serializer.is_valid(raise_exception=True)
        serializer.save()
        #返回响应
        return Response(serializer.data,status=status.HTTP_201_CREATED)
    def delete(self,request,book_id):
        BookInfo.objects.get(pk=book_id).delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

子路由：

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

运行结果：
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

二.GenericAPIView(二级视图)

DRF的GenericAPIView官网：https://www.django-rest-framework.org/api-guide/generic-views/#genericapiview
GenericAPIView继承自APIVIew类，为列表视图和详情视图，添加了常用的行为和属性；通常使用时，可搭配一个或多个Mixin扩展类。

1.定义的属性和方法

1）支持定义的属性：
　　列表视图与详情视图通用：
　　　　queryset 列表视图的查询集
　　　　　serializer_class 视图使用的序列化器
　　列表视图使用：
　　　　pagination_class 分页控制类
　　　　filter_backends 过滤控制后端
　　详情页视图使用：
　　　　lookup_field 查询单一数据库对象时使用的条件字段，默认为’pk’
　　　　lookup_url_kwarg 查询单一数据时URL中的参数关键字名称，默认与look_field相同
2）提供的方法：
　　列表视图与详情视图通用：
　　　　get_queryset(self)：返回视图使用的查询集，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写
　　　　get_serializer_class(self)：返回序列化器类，默认返回serializer_class，可以重写
　　　　get_serializer(self, args, *kwargs)：返回序列化器对象，被其他视图或扩展类使用，如果我们在视图中想要获取序列化器对象，可以直接调用此方法。
　　　　注意，在提供序列化器对象的时候，REST framework会向对象的context属性补充三个数据：request、format、view，这三个数据对象可以在定义序列化器时使用。
　　详情视图使用：　
　　　　get_object(self)： 返回详情视图所需的模型类数据对象，默认使用lookup_field参数来过滤queryset。 在试图中可以调用该方法获取详情信息的模型类对象。
　　　　若详情访问的模型类对象不存在，会返回404。
　　　　该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。

2.GenericAPIView实现列表视图

views.py:

# 使用二级视图GenericAPIView实现列表视图
class BookListGenericAPIView(GenericAPIView):
    # 提供公共的属性
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

    def get(self, request):
        # 查询所有的书籍(2种)
        # books = self.queryset
        books = self.get_queryset()
        # 将对象列表转换成字典列表(3种方法)
        # serializer = self.serializer_class(instance=books, many=True)
        # serializer = self.get_serializer_class()(instance=books, many=True)
        serializer = self.get_serializer(instance=books, many=True)
        # 返回响应
        return Response(serializer.data)

    def post(self, request):
        # 获取参数
        data_dict = request.data
        # 创建序列化器
        serializer = self.get_serializer(data=data_dict)
        # 校验
        serializer.is_valid(raise_exception=True)
        # 入库
        serializer.save()
        # 返回响应
        return Response(serializer.data, status=status.HTTP_201_CREATED)

子路由：

url(r'^generic_apiview_books/$', views.BookListGenericAPIView.as_view()),

运行结果：
在这里插入图片描述
在这里插入图片描述
由上，我们可以发现代码的可重复利用性大，如果我们想将书籍序列化器改为英雄序列化器，只需要将提供的公共属性中修改为英雄模型和英雄序列化器一处即可。

3.GenericAPIView实现详情视图

views.py:

# 使用二级视图GenericAPIView实现详情视图
class BookDetailGenericAPIView(GenericAPIView):
    # 提供通用的属性
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    def get(self, request, pk):
        # 1 获取书籍
        # get_object()根据pk到queryset中取出书籍对象
        book = self.get_object()
        # 2 创建序列化对象
        serializer = self.get_serializer(instance=book)
        # 3 返回响应
        return Response(serializer.data, status=status.HTTP_200_OK)

    def put(self, request, pk):
        # 获取数据，获取对象
        dict_data = request.data
        book = self.get_object()
        # 创建序列化对象
        serializer = self.get_serializer(instance=book, data=dict_data)
        # 校验，入库
        serializer.is_valid(raise_exception=True)
        serializer.save()
        # 返回响应
        return Response(serializer.data, status=status.HTTP_201_CREATED)

    def delete(self, request, pk):
        self.get_object().delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

子路由：

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

运行结果：
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

注意：在系统默认情况下，lookup_field参数为pk，如果想改变参数，可设置lookup_field=‘id’ 或者 lookup_url_kwarg=‘book_id’

views.py:

# 使用二级视图GenericAPIView实现详情视图
class BookDetailGenericAPIView(GenericAPIView):
    # 提供通用的属性
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    # lookup_field = 'id'
    lookup_url_kwarg = 'book_id'

    def get(self, request, book_id):
        # 1 获取书籍
        # get_object()根据pk到queryset中取出书籍对象
        book = self.get_object()
        # 2 创建序列化对象
        serializer = self.get_serializer(instance=book)
        # 3 返回响应
        return Response(serializer.data, status=status.HTTP_200_OK)

    def put(self, request, book_id):
        # 获取数据，获取对象
        dict_data = request.data
        book = self.get_object()
        # 创建序列化对象
        serializer = self.get_serializer(instance=book, data=dict_data)
        # 校验，入库
        serializer.is_valid(raise_exception=True)
        serializer.save()
        # 返回响应
        return Response(serializer.data, status=status.HTTP_201_CREATED)

    def delete(self, request, book_id):
        self.get_object().delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

子路由：

url(r'^generic_apiview_books/(?P<book_id>\d+)/$', views.BookDetailGenericAPIView.as_view()),

运行结果：
在这里插入图片描述

4.扩展类(MiXin)

DRF的MiXin官网：https://www.django-rest-framework.org/api-guide/generic-views/#mixins
MiXin的特点：
1.mixin类提供用于提供基本视图行为（列表视图，详情视图）的操作
2.配合二级视图GenericAPIView使用的
常见的mixin类：

类名称提供方法功能
ListModelMiXinlist查询所有的数据
CreateModleMiXincreate创建单个对象
RetrieveModleMiXinretrieve获取单个对象
UpdateModleMiXinupdate更新单个对象
DestroyModleMiXindestroy删除单个对象

（1）ListModelMixin
列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。

该Mixin的list方法会对数据进行过滤和分页。
源代码：

class ListModelMixin(object):
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
        # 过滤
        queryset = self.filter_queryset(self.get_queryset())
        # 分页
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
        # 序列化
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)

（2）CreateModelMixin
创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。

如果序列化器对前端发送的数据验证失败，返回400错误。

源代码：

class CreateModelMixin(object):
    """
    Create a model instance.
    """
    def create(self, request, *args, **kwargs):
        # 获取序列化器
        serializer = self.get_serializer(data=request.data)
        # 验证
        serializer.is_valid(raise_exception=True)
        # 保存
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

    def perform_create(self, serializer):
        serializer.save()

    def get_success_headers(self, data):
        try:
            return {'Location': str(data[api_settings.URL_FIELD_NAME])}
        except (TypeError, KeyError):
            return {}

（3）RetrieveModelMixin
详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。

如果存在，返回200， 否则返回404。

源代码：

class RetrieveModelMixin(object):
    """
    Retrieve a model instance.
    """
    def retrieve(self, request, *args, **kwargs):
        # 获取对象，会检查对象的权限
        instance = self.get_object()
        # 序列化
        serializer = self.get_serializer(instance)
        return Response(serializer.data)

（4）UpdateModelMixin
更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。

同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。

成功返回200，序列化器校验数据失败时，返回400错误。

源代码：

class UpdateModelMixin(object):
    """
    Update a model instance.
    """
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)

        if getattr(instance, '_prefetched_objects_cache', None):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            instance._prefetched_objects_cache = {}

        return Response(serializer.data)

    def perform_update(self, serializer):
        serializer.save()

    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)

（5）DestroyModelMixin
删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。

成功返回204，不存在返回404。

源代码：

class DestroyModelMixin(object):
    """
    Destroy a model instance.
    """
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()
        self.perform_destroy(instance)
        return Response(status=status.HTTP_204_NO_CONTENT)

    def perform_destroy(self, instance):
        instance.delete()

5.MiXin与GenericAPIView结合

（1）Mixin和二级视图GenericAPIView,实现列表视图
views.py:

from rest_framework.mixins import ListModelMixin, CreateModelMixin

class BookListMixinGenericAPIView(GenericAPIView, ListModelMixin, CreateModelMixin):
    # 提供公共的属性
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

    def get(self, request):
        return self.list(request)

    def post(self, request):
        return self.create(request)

子路由：

url(r'^mixin_generic_apiview_books/$', views.BookListMixinGenericAPIView.as_view()),

运行结果：
在这里插入图片描述
在这里插入图片描述
（2）Mixin和二级视图GenericAPIView,实现详情视图
views.py:

# mixin和二级视图GenericAPIView,实现详情视图
class BookDetailMixinGenericAPIView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
    # 提供通用的属性
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    lookup_field = 'id'

    def get(self, request, id):
        return self.retrieve(request)

    def put(self, request, id):
        return self.update(request)

    def delete(self, request, id):
        return self.destroy(request)

子路由：

url(r'^mixin_generic_apiview_books/(?P<id>\d+)/$', views.BookDetailMixinGenericAPIView.as_view()),

运行结果：
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

三.通用视图(三级视图）

DRF的Concrete View Classes官网：https://www.django-rest-framework.org/api-guide/generic-views/#concrete-view-classes
以下类是具体的通用视图。如果您使用的是通用视图，那么通常这就是您要使用的级别，除非需要大量的自定义行为。
常见的三级视图：

类名称父类提供方法作用
CreateAPIViewGenericAPIView，CreateModelMixinpost创建单个对象
ListAPIViewGenericAPIView，ListModelMixinget查询所有的数据
RetrieveAPIViewGenericAPIView, RetrieveModelMixinget获取单个对象
DestroyAPIViewGenericAPIView, DestroyModelMixindelete删除单个对象
UpdateAPIViewGenericAPIView, UpdateModelMixinput更新单个对象

1.三级视图实现列表视图

views.py:

# 三级视图实现列表视图
class BookListThirdView(ListAPIView, CreateAPIView):
    # 提供公共的属性
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

子路由：

url(r'^third_view_books/$', views.BookListThirdView.as_view()),

运行结果：
在这里插入图片描述
在这里插入图片描述

2.三级视图实现详情视图

views.py:

# 三级视图实现详情视图
class BookDetailThirdView(RetrieveAPIView, UpdateAPIView, DestroyAPIView):
    # 提供通用的属性
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    lookup_field = 'id'

子路由：

url(r'^third_view_books/(?P<id>\d+)/$', views.BookDetailThirdView.as_view())

运行结果：
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

四.ViewSets(视图集)

DRF的ViewSets官网：https://www.django-rest-framework.org/api-guide/viewsets/
视图集特点：
　　1.可以将一组相关的操作，放在一个类中进行完成
　　2.不提供get,post方法，使用retrieve，create方法来替代
　　3.可以将标准的请求方式（get,post,put,delete），和mixin中方法做映射
常见的视图集：

类名称父类作用
ViewSetAPIView，ViewSetMixin可以做路由映射
GenericViewSetGenericAPIView, ViewSetMixin可以做路由映射,可以使用三个属性,三个方法
ModelViewSetGenericAPIView,5个mixin类所有的增删改查功能,可以使用三个属性,三个方法
ReadOnlyModelViewSetGenericAPIView,RetrieveModelMixin,ListModelMixin获取单个,所有数据,可以使用三个属性,三个方法

当我们想在一个类中获取所有对象和单个对象时，我们又不能在一个类中写两个get方法，所以我们可以使用视图集来实现

1.ViewSet

继承自APIView，作用也与APIView基本类似，提供了身份认证、权限校验、流量管理等。

在ViewSet中，没有提供任何动作action方法，需要我们自己实现action方法。
views.py:

# 使用viewset实现获取所有和单个
class BooksViewSet(viewsets.ViewSet):
    """
    A simple ViewSet for listing or retrieving books.
    """
    def list(self, request):
        queryset = BookInfo.objects.all()
        serializer = BookInfoModelSerializer(instance=queryset, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        queryset = BookInfo.objects.all()
        book = get_object_or_404(queryset, pk=pk)
        serializer = BookInfoModelSerializer(instance=book)
        return Response(serializer.data)

设置路由：

url(r'^viewset/$', views.BooksViewSet.as_view({'get': 'list'})),
url(r'^viewset/(?P<pk>\d+)/$', views.BooksViewSet.as_view({'get': 'retrieve'})),

运行结果：
在这里插入图片描述
在这里插入图片描述

2.ReadOnlyModelViewSet

继承自GenericAPIVIew，同时包括了ListModelMixin、RetrieveModelMixin。
views.py:

# 使用ReadOnlyModelViewSet实现获取单个和所有
class BooksReadOnlyModelViewSet(ReadOnlyModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

设置路由：

url(r'^readonly_viewset/$', views.BooksReadOnlyModelViewSet.as_view({'get': 'list'})),
url(r'^readonly_viewset/(?P<pk>\d+)/$', views.BooksReadOnlyModelViewSet.as_view({'get': 'retrieve'})),

运行结果：
在这里插入图片描述
在这里插入图片描述

3.ModelViewSet

继承自GenericAPIVIew，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。
views.py:

# ModelViewSet实现列表视图，详情视图功能
class BookModelViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

设置路由：

url(r'^model_viewset/$', views.BookModelViewSet.as_view({'get': 'list',"post":"create"})),
url(r'^model_viewset/(?P<pk>\d+)/$', views.BookModelViewSet.as_view({'get': 'retrieve','put':'update','delete':'destroy'})),

运行结果：
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

4.视图集额外动作

（1）基本使用
在视图集中，除了上述默认的方法动作外，还可以添加自定义动作。

view.py:

class BookModelViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer  

    # 需求：获取阅读量大于111的书籍
    def bread_book(self, request):
        # 获取指定书籍
        books = BookInfo.objects.filter(bread__gt=111)
        # 创建序列化器对象
        serializer = self.get_serializer(instance=books, many=True)
        # 返回响应
        return Response(serializer.data)

写在视图集里面的内容，都是做路由映射的
子路由：

url(r'^books/bread/$', views.BookModelViewSet.as_view({'get': 'bread_book'})),

运行结果：
在这里插入图片描述
（2）partial
可以编写额外动作添加参数，并且更新局部信息
views.py:

class BookModelViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

    # 需求：修改书籍编号为11的，阅读量为222
    def update_book_bread(self, request, pk):
        # 获取参数
        book = self.get_object()
        data = request.data
        # 创建序列化器对象
        serializer = self.get_serializer(instance=book, data=data, partial=True)
        # 校验，入库
        serializer.is_valid(raise_exception=True)
        serializer.save()
        # 返回响应
        return Response(serializer.data, status=201)

子路由：

url(r'^books/bread/(?P<pk>\d+)/$', views.BookModelViewSet.as_view({'put': 'update_book_bread'})),

运行结果：
在这里插入图片描述

五.Router(路由）

对于视图集ViewSet，我们除了可以自己手动指明请求方式与动作之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息。
REST framework提供了两个router：SimpleRouter和DefaultRouter
views.py:

class BookModelViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

    # 需求：修改书籍编号为11的，阅读量为222
    def update_book_bread(self, request, pk):
        # 获取参数
        book = self.get_object()
        data = request.data
        # 创建序列化器对象
        serializer = self.get_serializer(instance=book, data=data, partial=True)
        # 校验，入库
        serializer.is_valid(raise_exception=True)
        serializer.save()
        # 返回响应
        return Response(serializer.data, status=201)

1.DefaultRouter

子路由：

from . import views
from rest_framework.routers import DefaultRouter

urlpatterns = [
]

# 创建路由对象
router = DefaultRouter()
# 注册视图表
router.register('books', views.BookModelViewSet, basename='test')
urlpatterns += router.urls
# 输出结果：
print(urlpatterns)

说明：
　register(prefix, viewset, base_name)
　　　prefix：该视图集的路由前缀
　　　viewset：视图集
　　　base_name：路由名称的前缀

运行结果：

# 列表路由及其json形式
[<RegexURLPattern test-list ^books/$>, 
<RegexURLPattern test-list ^books\.(?P<format>[a-z0-9]+)/?$>, 
# 详情路由及其json形式
<RegexURLPattern test-detail ^books/(?P<pk>[^/.]+)/$>, 
<RegexURLPattern test-detail ^books/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$>, 
# 根路由及其json形式
<RegexURLPattern api-root ^$>, 
<RegexURLPattern api-root ^\.(?P<format>[a-z0-9]+)/?$>]

由上可知，Routers能够帮助我们快速实现路由信息

部分截图：
列表路由：在这里插入图片描述

列表路由json形式：

在这里插入图片描述

详情路由：
在这里插入图片描述
在这里插入图片描述
详情路由json形式
在这里插入图片描述
根路由：
在这里插入图片描述
在这里插入图片描述

注意点：
　　在网页上访问时，需要在settings中注册rest_framework
　　使用DRF可以自动根据前端需要的类型，返回对应格式的数据

2.SimpleRouter

子路由：

from . import views
from rest_framework.routers import SimpleRouter

urlpatterns = [
]

# 创建路由对象
router = SimpleRouter()
# 注册视图表
router.register('books', views.BookModelViewSet, basename='test')
urlpatterns += router.urls
# 输出结果：
print(urlpatterns)

运行结果：

[<RegexURLPattern test-list ^books/$>, 
<RegexURLPattern test-detail ^books/(?P<pk>[^/.]+)/$>]

在这里插入图片描述

3.视图集包含action装饰器

以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。

action装饰器可以接收两个参数：
　　　methods: 该action支持的请求方式，列表传递
　　　detail: 表示是action中要处理的是否是视图资源的对象（即是否通过url路径获取主键）
　　　　　True：表示使用通过URL获取的主键对应的数据对象
　　　　　False：表示不使用URL获取主键
views.py:

class BookModelViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer
    # 需求：获取阅读量大于111的书籍
    @action(methods=['get'], detail=False) # 生成路由规则：前缀/方法名
    def bread_book(self, request):
        # 获取指定书籍
        books = BookInfo.objects.filter(bread__gt=111)
        # 创建序列化器对象
        serializer = self.get_serializer(instance=books, many=True)
        # 返回响应
        return Response(serializer.data)
    # 需求：修改书籍编号为13的，阅读量为222
    @action(methods=['put'], detail=True) # 生成路由规则：前缀/{pk}/方法名/
    def update_book_bread(self, request, pk): 
        # 获取参数
        book = self.get_object()
        data = request.data
        # 创建序列化器对象
        serializer = self.get_serializer(instance=book, data=data, partial=True)
        # 校验，入库
        serializer.is_valid(raise_exception=True)
        serializer.save()
        # 返回响应
        return Response(serializer.data, status=status.HTTP_201_CREATED)

子路由：

from . import views
from rest_framework.routers import SimpleRouter
urlpatterns = [
]

# 创建路由对象
router = SimpleRouter()
# 注册视图表
router.register('books', views.BookModelViewSet, basename='test')
urlpatterns += router.urls
# 输出结果：
print(urlpatterns)

运行结果：

[<RegexURLPattern test-list ^books/$>, 
<RegexURLPattern test-bread-book ^books/bread_book/$>, 

<RegexURLPattern test-detail ^books/(?P<pk>[^/.]+)/$>, 
<RegexURLPattern test-update-book-bread ^books/(?P<pk>[^/.]+)/update_book_bread/$>]

截图：
在这里插入图片描述
在这里插入图片描述

4.路由router形成url的方式

1）SimpleRouter
在这里插入图片描述

2）DefaultRouter
在这里插入图片描述

DefaultRouter与SimpleRouter的区别是：DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据

奋斗的源
关注
  • 3
    点赞
  • 踩
  • 32
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
基于函数视图、自定义序列化器、类视图APIView, GenericAPIView和GenericViewSet视图集代码
03-25
文章3、DRF实战总结：基于类的视图APIView, GenericAPIView和GenericViewSet视图集 DRF提供了4种编写CBV类API的方式，到底哪种CBV开发模式更好? 答案是各有利弊 o 基础的API类：可读性最高，代码最多，灵活性最高...
django drf框架自带的路由及最简化的视图
09-18
在开发Web API时，Django REST Framework（DRF）是一个非常强大的工具，它提供了一整套功能丰富的组件，包括路由和视图。本篇文章将详细探讨DRF框架中自带的路由系统以及如何使用最简化的视图。 ## 路由（Routing）...
基于vgg16进行迁移学习服装分类
最新发布
weixin_55982578的博客
03-06 1113
的学习记录。
DRF--GenericAPIView及其搜索,排序,分页功能,分页功能定制
qq_40132294的博客
07-13 1445
1.GenericAPIView 1.1 具备View的所有特性 1.2 具备APIView中的认证，授权，限流功能 1.3 支持对于获取列表数据接口的搜索，排序，分页功能 1.4 一旦继承了GenericAPIView,往往需要指定queryset,serializer_class类属性 1.4.1 queryset指定的是:当前类视图的内部的实例方法会使用的查询集对象 1..4.2 ser
3、DRF实战总结：基于类的视图APIView, GenericAPIView和GenericViewSet视图集（附源码）
SteveRocket's-Blog
03-27 1217
DRF提供了4种编写CBV类API的方式，到底哪种CBV开发模式更好? 答案是各有利弊 o 基础的API类：可读性最高，代码最多，灵活性最高。当需要对API行为进行个性化定制时，建议使用这种方式。 o 通用generics.*类：可读性好，代码适中，灵活性较高。当需要对一个模型进行标准的增删查改全部或部分操作时建议使用这种方式。 o 使用视图集viewset: 可读性较低，代码最少，灵活性最低。当需要对一个模型进行标准的增删查改的全部操作且不需定制API行为时建议使用这种方式。
Django Rest framework基础使用之View：APIView, mixins, generic, viewsets
aimiandai4698的博客
09-27 610
先看一张图，对DRF的各个APIView，Mixin，Viewset等有个基本印象： 具体使用方法： 1、APIView： 　　DRF 的API视图 有两种实现方式： 　　一种是基于函数的：@api_view 　　一种是基于类的：APIView，APIView是Restframework提供的所有视图的基类，继承自Django的View父类 　　1）@api_view ...
【DRF】Django Rest Framework（5.DRF中的通用视图类-GenericAPIView方法说明与使用说明）
Mogul的博客
02-20 613
继承自 APIView增加了操作序列化器和数据库查询的方法，作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时，可搭配一个或者多个Mixin扩展类源码当我们查看 GenericAPIView 的源码时，发现，他也是继承了views.APIView。
python之django框架类视图(views)路由反射解读
最爱嫣夜来
06-23 988
最近一直在看django框架的rest-framework库，尝试看了一下源码，觉得挺有意思的。这里记录一下自己对于django在使用rest_framework写类视图以及路由分发到类视图函数执行的整个过程，给自己这7秒钟记忆的脑子存个档，方便以后查看。 第一部分 示例代码 依赖包： django==2.1.7 djangorestframework==3.11.0 mysqlclient==1.4.6 第一步：定义models模型类，这里随便写了一个 from django.db import
Django框架之DRF 基于mixins来封装的视图详解
09-19
今天小编就为大家分享一篇Django框架之DRF 基于mixins来封装的视图详解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
Django Rest_framework 4(APIView、GenericAPIView、ViewSet)
weixin_44799030的博客
01-18 335
详解Django DRF框架中APIView、GenericAPIView、ViewSet区别 https://zhuanlan.zhihu.com/p/72527077 View->APIView->GenericAPIView->Mixin扩展类->子类视图 一、DRF类视图-APIView APIView视图基类： Django框架View类的子类，在View类的基础上封装了一些功能。 功能如下： 1. 视图request参数变成了Request类的对象，不再是Djan
APIView和View的区别
qq_40109570的博客
11-19 283
前言 django中编辑视图views.py有两种方式，一种是基于类的实现，另外一种是函数式的实现方式，两种方法都可以用。 REST框架提供了一个APIView类，它是Django View类的子类。 View与APIView的区别 View是Django默认的视图基类，APIView是REST framework提供的所有视图的基类, 继承自Django的View。 APIView与...
django-rest-framework框架总结之View视图之APIView、GenericAPIView、视图集ViewSet
weixin_43865008的博客
02-02 1718
基于django-rest-framework框架的View视图进行总结，其中包含APIView、GenericAPIView、视图集ViewSet中的使用和特性，方便日后自己查看资料。
Django REST Framework 之视图梳理APIView、GenericViewSet、ModelViewSet(超详细)
她°
05-31 1638
APIView DRF 为了更符合 restful api 规范，在 View 上层做了一层封装，就是 APIView，View 本身没有权限和认证以及限流等的操作，只做请求的分发，然后返回，里面就是一些简单的分发逻辑，但APIView不同，重写了 as_view方法，里面做了认证、限流、权限、渲染很多东西。 这种视图还不够通用，需要自己写一些分页、序列化、queryset 之类的东西。 class APIView(View): # The following policies may be se
Django DRF APIView Serializer项目配置
weixin_45954124的博客
10-27 381
DRF APIView 1 DRF框架的 8 个核心功能 认证 （用户登录校验用户名密码或者token是否合法） 权限 (根据不同的用户角色，可以操作不同的表) 限流 （限制接口访问速度） 序列化 （返回json） 分页 （把数据分成一页一页） 版本 （接口版本号，用 v1/v2/v3） 过滤 （筛选所需要的数据） 排序 （对数据进行排序） 1.1 相关包 '''1.序列化相关''' serializer ModelSerializer '''2.DRF视图函数继承''' APIV
DRF-基类: APIview和GenericAPIView
张鑫宇
03-12 604
1. APIview APIView是REST framework提供的所有视图的基类, 继承自Django的View父类 APIView与View的不同之处: 传入到视图方法中的是REST framework的Request对象, 而不是Django的HttpRequeset对象； 视图方法可以返回REST framework的Response对象, 视图会为响应数据设置（ren...
DRF之REST规范介绍及View请求流程分析
a86123969的博客
12-11 310
　　编程是数据结构和算法的结合，而在Web类型的App中，我们对于数据的操作请求是通过url来承载的，本文详细介绍了REST规范和CBV规范和CBV请求流程。 　　编程即数据结构和算法的结合。简单的程序可能不需要跟用户交互数据，但是现代的应用程序几乎都需要跟用户进行交互，不分应用程序类型，不管是CS型还是BS型的程序都是如此，而Python最擅长的Web App即BS型的程序，就是通过...
关于返回上一级视图后视图中tableview内容不刷新的问题
qinhuapi6738的博客
12-29 269
有两个视图A,B,A跳到B后，从B再返回A，这个时候，A视图中的tableview上面的内容不在刷新了，或者说是cellForRowAtIndexPath(返回单元格)不走了，页面返回的方式是：popViewController，请问引起tableview不再刷新的原因是什么？该如何修改？谢谢
Django通用视图APIView和视图集ViewSet的介绍和使用
果果木的博客
07-17 655
1.APIView DRF框架的视图的基类是 APIView APIView的基本使用和View类似 Django默认的View请求对象是 HttpRequest，REST framework 的请求对象是 Request。 Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。 HttpRequest.GET ————> Request.query_params HttpRequest.POST 、HttpRequest.body————> Request.data
django drf 中文
08-01
Django DRF（Django REST Framework）是一个用于构建RESTful API的开发工具包，是基于Django框架的一个扩展库。它提供了一套简单且灵活的方式来构建高质量的API，能够在短时间内为开发者快速构建出功能强大和安全的接口。 Django DRF的主要特点包括：强大的序列化支持、灵活的路由系统、权限管理、异常处理、认证、版本控制等。它能够自动处理HTTP请求和响应，并支持多种数据序列化和处理方式，比如JSON、XML等。同时，它提供了一套丰富的视图、装饰器和Mixin类，能够有效地实现API的细粒度控制和过滤。 使用Django DRF可以快速构建出符合最佳实践的API，它使得开发者能够高效地进行开发工作，并提供了一些有用的功能，比如简单的API文档生成、Web浏览API调试界面等。此外，Django DRF还提供了一些对关系数据库的支持，比如对Model关联、过滤、排序等操作的封装。 总之，Django DRF是一个非常方便和强大的工具包，它能够帮助开发者更高效地编写和管理RESTful API，并且是Django社区中使用最广泛的API开发框架之一。无论是小型项目还是大型项目，使用Django DRF都能够提供良好的开发体验和强大的功能支持。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值