【和訳】Django Rest Framework チュートリアル3：クラスベースのビュー

【和訳】Django Rest Framework クイックスタート

【和訳】Django Rest Framework チュートリアル１：シリアル化

【和訳】Django Rest Framework チュートリアル２：リクエストとレスポンス

【和訳】Django Rest Framework チュートリアル３：クラスベースのビュー

【和訳】Django Rest Framework チュートリアル４：認証とアクセス許可

【和訳】Django Rest Framework チュートリアル５：リレーションとハイパーリンクされたAPI

【和訳】Django Rest Framework チュートリアル６：ビューセットとルーター 

チュートリアル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):
    """
    全スニペットの一覧表示、スニペットの新規作成
    """
    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のインスタンスビュー（Detail View）も更新する必要があります。

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/<int:pk>/', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

これで完了です。
開発サーバーを実行すると、すべてが以前と同じように機能するはずです。

ミックスインの使用

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

これまで使用してきた作成/取得/更新/削除操作は、作成するモデルベースの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の認証とアクセス許可を処理する方法を見ていきます。