【Django】REST Frameworkを利用したWeb APIの実装

RESTとは

REST（Representational State Transfer）とはWebサービスを構築する際の考え方や原則（ルールや性質）の集まりのことです。
Web制作のための設計モデルとも言えます。

RESTの原則は、容易にデータへアクセスできることを目的としています。

RESTなWebアプリケーションでは、URIにHTTPメソッドでアクセスすることでデータの送受信ができます。

RESTの４原則

RESTに従って設計するということは、以下の４つの原則に準ずる必要があります。

この原則に準ずるものを「RESTfulである」といいます。

• リソースはURIで公開
• インターフェースの統一
• ハイパーメディアの使用（JSON、HTML、XMLなど）
• ステートレスな通信

上記の原則がありますが、SOAP（Simple Object Access Protocol）などよりも使いやすいです。RESTは高速かつ軽量であるため、スケーラビリティが向上するため、Webサービスやモバイルアプリに利用されます。

Django REST Frameworkのインストール

Django REST Frameworkをpipを使ってインストールします。

pip install djangorestframework

次にDjango で利用できるように、プロジェクト内の設定ファイルsettings.pyのINSTALLED_APPSにrest_frameworkを追加します。

INSTALLED_APPS = [
    …
    'rest_framework',
]

Serializerの作成

rest_framework.serializersのSerializerクラスを使ったスクリプトを作成します。
ここではアプリケーションフォルダ内にserializers.pyとして作成しました。

Serializerはデータベースから取り出したモデルのデータをJSONにシリアライズ（serialize）する、データベースへのデータ追加・削除・更新、データのバリデーションなどに利用されます。

スクリプトではrest_framework.serializers.ModelSerializerを継承したクラスを作成します。

# serializers.py
from rest_framework import serializers
from .models import Template

class TemplateSerializer(serializers.ModelSerializer):
    class Meta:
        model = Template
        fields = ('template_name', 'category',)

ここではモデルTemplateのSerializerを作成し、fieldsにtemplate_nameとcategoryを指定しています。

ViewSetsを使用したAPI用Viewの作成

ViewSetsというコンポーネントを利用したクラスベースビューを作成します。

API用のビュースクリプトをアプリケーションフォルダ内に作成します。
ここではアプリケーションフォルダ内にapi_views.pyとして作成しました。

作成したスクリプト内にはrest_framework.viewsets.ModelViewSetを継承したクラスを記述します。

これがAPIの本体になり、ここに機能を追加することで、外部に提供する機能が追加されていきます。

# api_views.py
from rest_framework import viewsets, filters
from .models import Template
from .serializers import TemplateSerializer

class TemplateViewSet(viewsets.ModelViewSet):
    queryset = Template.objects.all()
    serializer_class = TemplateSerializer

クエリセットにTemplateオブジェクトの全データ、シリアライザークラスにTemplateSerializerを指定しています。

urls.pyへの追記

APIのリソースにアクセスしたときに、上記で作成した機能が実行できるようにプロジェクトフォルダ内のurls.pyに追記を行います。

URLディスパッチャーにはRouterクラスを利用します。

from rest_framework import routers
from record import api_views as record_api_views

router = routers.DefaultRouter()
router.register('template', record_api_views.TemplateViewSet)

urlpatterns = [
    …
    path('api/', include(router.urls)),
]

ブラウザからAPIのURLにアクセスすると、次のようにJSONのレスポンスがブラウザ用に見やすいページで閲覧できます。

http://127.0.0.1:8000/api/

http://127.0.0.1:8000/api/template/