Django REST framework-教程03-class-based views原创翻译

python技术交流群332680349,资源分享,技术交流。

我们还可以使用基于类的视图编写我们的API视图,而不是基于函数的视图。正如我们将看到的,这是一个强大的模式,允许我们重用常用的功能,并帮助我们保持代码不重复编写。

01-使用基于类的视图重写我们的API

我们将首先将根视图重写为基于类的视图。所有这一切都涉及到views.py重构。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status


class SnippetList(APIView):
    """
    List all snippets, or create a new snippet.
    """
    def get(self, request, format=None):
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = SnippetSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

到现在为止还挺好。它看起来与以前的情况非常相似,但是我们在不同的HTTP方法之间有更好的分离。我们还需要更新实例视图在views.py。

lass SnippetDetail(APIView):
    """
    Retrieve, update or delete a snippet instance.
    """
    def get_object(self, pk):
        try:
            return Snippet.objects.get(pk=pk)
        except Snippet.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet)
        return Response(serializer.data)

    def put(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

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

看起来不错 再次,它现在仍然非常类似于基于函数的视图。
我们还需要重构urls.py一下我们使用基于类的视图

from django.conf.urls import url
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views

urlpatterns = [
    url(r'^snippets/$', views.SnippetList.as_view()),
    url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

好的,我们完成了 如果运行开发服务器,那么应该像以前一样工作。

02-使用mixins

使用基于类视图的成功的途径之一,就是让我们轻松地组合可重用的行为。

到目前为止,我们使用的创建/查询/更新/删除操作将与我们创建的任何支持模型的API视图非常相似。这些常见的行为是在REST框架的mixin类中实现的。

我们来看看我们如何使用mixin类编写视图。这是我们的views.py模块了。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import mixins
from rest_framework import generics

class SnippetList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

我们会花点时间仔细检查这里发生的变化。我们正在使用的构建我们的视图用GenericAPIView,并在加ListModelMixin和CreateModelMixin。

基类提供核心功能,而mixin类提供.list()和.create()操作。然后,我们将明确的绑定get和post方法绑定,到需要的时候调用。到目前的代码修改已经足够简单

class SnippetDetail(mixins.RetrieveModelMixin,
                    mixins.UpdateModelMixin,
                    mixins.DestroyModelMixin,
                    generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    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)

很相似 同样,我们正在使用的GenericAPIView类来提供核心功能,并混入增加提供.retrieve(),.update()和.destroy()操作。

03-使用一般的类视图

使用mixin类,我们重写了这些视图,使用的代码比以前少一些,但我们可以进一步。REST框架提供了一组集合已经包涵通用视图,我们可以使用它来更简单地优化我们的模块。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import generics


class SnippetList(generics.ListCreateAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer


class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

哇,这很简洁。我们已经减少了大量的代码但是不影响功能的实现,而且我们的代码看起来很好,整洁,Django的习惯用法。

接下来,我们将介绍本教程的第4部分,我们将在此介绍如何处理API的身份验证和权限。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值