我们也可以使用类视图,而不是基于函数的视图来编写 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):
"""
列出所有代码片段,或创建一个新的代码片段。
"""
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
中的实例视图。
class SnippetDetail(APIView):
"""
检索、更新或删除一个代码片段实例。
"""
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)
看起来不错。再次说明,这与基于函数的视图非常相似。
现在我们使用基于类的视图,所以还需要稍微重构我们的 snippets/urls.py
。
from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views
urlpatterns = [
path('snippets/', views.SnippetList.as_view()),
path('snippets//', views.SnippetDetail.as_view()),
]
urlpatterns = format_suffix_patterns(urlpatterns)
好的,我们完成了。如果你运行开发服务器,一切应该与之前一样正常工作。
使用混合类
使用基于类的视图的一个重要优势在于,它允许我们轻松地组合可重用的行为片段。
我们到目前为止使用的创建 / 检索 / 更新 / 删除操作,对于任何基于模型的 API 视图来说都将非常相似。这些通用行为在 REST 框架的混合类中得到了实现。
让我们看看如何通过使用混合类来组合视图。下面是我们的 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
。
基类提供了核心功能,混合类提供了 .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()
操作。
使用通用类视图
通过使用混合类,我们重写了视图,比之前使用的代码略少,但我们还可以更进一步。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 的认证和权限。