チュートリアル 3: クラスベースビュー

関数ベースビューではなく、クラスベースビューを使用してAPIビューを作成することもできます。これからわかるように、これは共通の機能を再利用し、コードをDRYに保つのに役立つ強力なパターンです。

クラスベースビューを使用して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のインスタンスビューも更新する必要があります。

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)

これは良さそうです。ここでも、今のところは関数ベースビューとよく似ています。

クラスベースビューを使用しているので、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/<int:pk>/', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

はい、完了しました。開発サーバーを実行すると、すべてが以前とまったく同じように動作するはずです。

mixinの使用

クラスベースビューを使用する大きな利点の1つは、再利用可能な動作の断片を簡単に構成できることです。

これまで使用してきた作成/取得/更新/削除操作は、作成するモデルベースのAPIビューではほぼ同じになります。これらの共通の動作は、REST frameworkの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を追加しています。

ジェネリッククラスベースビューの使用

mixinクラスを使用することで、以前よりも少ないコードでビューを書き換えることができましたが、さらに一歩進むことができます。REST frameworkは、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の認証とパーミッションをどのように扱うかを見ていきます。