Tutorial 3: Class based views
前回の記事「Django REST frameworkチュートリアル その２」の続きです。
views.py (Class based view)
前回はviewを@api_view()デコレータをつけたfunction based viewで書き換えました。今回は、viewをclass based viewに書き換えてみます。
function based viewに比べ、コードが再利用しやすくなるという利点があるようです。
では、前回書いたviews.pyのコードを書き換えてみましょう。
snippets/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)
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)
以前は関数で定義していたviewですが、APIViewを継承したクラスで書き換えられています。それとGET、POSTなどのメソッドごとの条件分岐はなくなり、メソッドごとに一つの関数を定義していますね。
urls.py
class based viewに変更したので、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)
これでclass based viewの実装が完了です。function based viewと同様に動くと思います。
views.py (mixinを使った実装)
これまでviewに実装してきたGET、POST、PUT、DELETEのようなメソッドはモデルベースのAPIにおいてはほぼ同じような挙動を実装したくなるかと思います。そこでREST frameworkでは、これらの一般的な実装をすでに用意してくれています。
mixinクラスを継承することでこれらの実装を簡単に再利用することができます。
それでは、mixinクラスを使ってviewを書き換えてみましょう。
snippets/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)
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)
各メソッドに対応する関数の中身が簡潔になったのがわかるかと思います。
GenericAPIがコアとなる関数群を提供していて、各mixinが.list()やcreate()などのアクションを定義してくれているようです。
views.py (genericsを使った実装)
mixinを使うことでviewの中身が簡潔になりましたが、これらをさらに簡潔に書くことができます。mixed-in generic viewを使います。
snippets/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
チュートリアルの続きはこちらです。