咱们也可使用基于类的视图编写咱们的API视图,而不是基于函数的视图。咱们将看到这是一个强大的模式,容许咱们重用经常使用功能,并帮助咱们保持代码DRY。html
使用基于类的视图重写咱们的API
咱们将首先将根视图重写为基于类的视图。全部这一切都涉及到一些重构views.py。django
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): # APIView实际继承django总的View # from django.views.generic import View """ # 这里是SnippetList接口描述 List all snippets, or create a new snippet. """ def get(self, request, format=None): snippets = Snippet.objects.all() # manay=True 用于querySet对象 serializer = SnippetSerializer(snippets, many=True) 3 Respone比django的response更强大 return Response(serializer.data) def post(self, request, format=None): serializer = SnippetSerializer(data=request.data) if serializer.is_valid(): # .save()是调用SnippetSerializer中的create()方法 serializer.save() return Response(serializer.data, status=status.HTTP_201_CREATED) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
到如今为止还挺好。它看起来与之前的状况很是类似,可是咱们在不一样的HTTP方法之间有更好的分离。咱们还须要更新实例视图views.py。segmentfault
class 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)
好的,咱们完成了 若是运行开发服务器,那么应该像之前同样工做。函数
使用mixins
使用基于类视图的最大好处之一就是让咱们轻松地组合可重用的行为。post
到目前为止,咱们使用的建立/查看/更新/删除操做与咱们建立的任何支持模型的API视图类似。这些常见的行为是在REST框架的mixin类中实现的。url
咱们来看看咱们如何使用mixin类编写视图。这是咱们的views.py模块了。rest
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): # mixins.CreateModelMixin 能够保存数据 # generics.GenericAPIView 继承了APIView queryset = Snippet.objects.all() serializer_class = SnippetSerializer def get(self, request, *args, **kwargs): # self.list是ListModelMixin的list函数 # 功能是过滤、分页、调用serializer,将数据序列化 return self.list(request, *args, **kwargs) def post(self, request, *args, **kwargs): return self.create(request, *args, **kwargs)
咱们会花一点时间仔细检查这里发生的状况。咱们用GenericAPIView建一个视图,并在加ListModelMixin和CreateModelMixin。code
基类提供核心功能,而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()方法。
使用泛型类视图
使用mixin类,咱们重写了这些视图,使用的代码比之前少得多,可是咱们能够进一步。REST框架提供了一组已经混合的通用视图,咱们可使用它来修剪咱们的views.py模块。
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的身份验证和权限。
Django REST FrameWork中文文档目录:
Django REST FrameWork 中文教程1:序列化
Django REST FrameWork 中文教程2:请求和响应
Django REST FrameWork 中文教程3:基于类的视图
Django REST FrameWork 中文教程4:验证和权限
Django REST FrameWork 中文教程5:关系和超连接API