咱们还可使用基于类的视图而不是基于函数的视图来编写API视图。咱们将看到这是一个强大的模式,容许咱们重用经常使用功能,并帮助咱们保持代码。
使用基于类的视图重写咱们的API
咱们首先将根视图重写为基于类的视图。全部这些涉及的重构views.py。django
#1. 相关模块服务器
from .models import Snippet
from .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类,于url路由要匹配函数
class SnippetList(APIView):
def get(self, request, format=None):
snippets = Snippet.objects.all()
serializer = SnippetSerializer(snippets, many=True)
return Response(serializer.data)post
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)# 返回http状态码信息
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)# 返回报错信息url
到如今为止还挺好。它看起来与前一种状况很是类似,但咱们在不一样的HTTP方法之间有了更好的分离。咱们还须要更新实例视图views.py。rest
class SnippetDetail(APIView):
# 获取pk=id值,进行单条的查看,获取,修改和删除
def get_object(self, pk):
try: #若是此页面不存在则返回404页面不存在的一个异常处理
return Snippet.objects.get(pk=pk)
except Snippet.DoesNotExist:
raise Http404orm
def get(self, request, pk): # 定义参数pk对应id值,指你要进行单条操做的一条数据
snippet = self.get_object(pk)
serializer = SnippetSerializer(snippet)
return Response(serializer.data)ip
def put(self, request, pk):
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):
snippet = self.get_object(pk)
snippet.delete()
return Response(status=status.HTTP_204_NO_CONTENT)
那看起来不错。一样,它如今仍然很是相似于基于功能的视图。
咱们还须要snippets/urls.py稍微重构一下,由于咱们正在使用基于类的视图。
from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from demo import views
urlpatterns = [
path('snippets/', views.SnippetList.as_view()),
path('snippets/<int:pk>/', views.SnippetDetail.as_view()),# 根据视图中匹配id
]
urlpatterns = format_suffix_patterns(urlpatterns)
好的,咱们已经完成了。若是你运行开发服务器,一切都应该像之前同样工做。
使用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()行动。
使用基于类的通用视图
使用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