Django REST frameworkの基本

はじめに

Django REST frameworkを使うと、簡単にAPIを作成することができます。
ここでは、Django REST frameworkについて、最低限知っておきたいことにしぼって解説します。

settings.pyへの追記

INSTALLED_APPSにrest_frameworkを追記します。

settings.py

INSTALLED_APPS = [
    'rest_framework', # 追加
]

serializerの作成

次に、serializerを作成していきます。

serializers.py

from rest_framework import serializers


class SampleSerializer(serializers.ModelSerializer):

    class Meta:
        model = 対象モデル
        fields = 含めるフィールド（全部の場合は'__all__'） # または、exclude = (除外したいフィールド)

viewの作成

serializerを作成したら、views.pyに追記します。

views.py

from rest_framework import generics


class SampleListAPI(generics.ListAPIView):
    queryset = 対象モデル.objects.all()
    serializer_class = シリアライザー


class SampleDetailAPI(generics.ListAPIView):
    queryset = 対象モデル.objects.all()
    serializer_class = シリアライザー

urls.pyの設定

最後に、ルーティングの設定をして一通り完了です。

urls.py

from django.urls import path

from . import views


urlpatterns = [
    path('api/sample/list', views.SampleListAPI.as_view(), name='api_sample_list'),
    path('api/sample/detail/<int:pk>/', views.SampleDetailAPI.as_view(), name='api_sample_detail'),
]

まとめ

ここでは、Django REST frameworkを用いたAPI作成方法について解説しました。