Tutorial 3: Class-based Views

また、APIビューは、関数ベースではなくクラスベースのビューを使用して作成することもできます.これは、通常の機能とコードのDRYの再利用に役立つ強力なモードです.

Rewriting our API using class-based views

クラスベースのビューを使用して、クラスベースのビューで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)

簡単な機能のためにRetrieve Update Deleteを書きます

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)

関数ベースのビューと非常に似ています.
また、snippet/urls.pyクラスベースのビューを使用するため、いくつかの再パッケージが必要です.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)

開発サーバを実行した後、すべてが以前のように正常に動作する必要があります.

Using mixins

クラスベースのビューを使用する大きな利点は、再利用可能なアクションビットを簡単に構成できることです.
これまで使用されてきた作成/検索/更新/削除操作は、作成したモデルがAPIビューをサポートするのと非常に似ています.これらの典型的な挙動は、RESTフレームワークのmixinクラスにおいて達成される.mixinクラスの組織ビューの使用方法を見てみましょう.ここの景色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)

General APIViewクラスを使用してキー機能を提供し、混入を追加します.retrieve(), .()とを更新します.destroy()の仕事をしましょう

Using generic class-based views

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

以下のtutorial 4では、APIの処理方法について説明する인증 및 권한.