【その1】チュートリアルから学ぶDjangoRESTframework

Djangoを使ってRESTAPIサーバーを構築する時によく利用される「DjangoRESTframeworlk」の使い方を公式ドキュメントに沿って解説していきます。

必要なライブラリのインストール
Djangoの準備
Serializersの設定
Viewsの設定
URLsの設定
試しにユーザー一覧を取得してみる
まとめ

必要なライブラリのインストール

pip install djangorestframework

実際に運用していく場合には以下のライブラリもあると便利ですが、今回は最低限の動作を見ていくので省略します。

markdown
django-filter

Djangoの準備

Djangoのプロジェクト（myproject）とアプリ（myapp）をそれぞれ作成しておきます。

django-admin startproject myproject
cd myproject
python manage.py startapp myapp

次にmigrateして管理者ユーザーを作成します。

python manage.py migrate
python manage.py createsuperuser --email admin@example.com --username admin

パスワードはお好きなパスワードで大丈夫ですが、この後にパスワードを指定する所がありますので、メモしておいてください。
（ここでは「password123」とします。）
myprojectフォルダ配下にある「settings.py」に以下をそれぞれ追記してください。

# すでにINSTALLED_APPSの記述があると思いますので、そこの一番下に追記
INSTALLED_APPS = [
    ...
    'rest_framework',
]

# この記述はまるっとコピペで大丈夫
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10
}

Serializersの設定

Serializersとはデータのやり取りをするときの翻訳機のようなものです。
（このあたり理解が曖昧なので、違うかもしれません。）
myappフォルダ配下に「serializers.py」を作成し以下の内容を記述します。

from django.contrib.auth.models import User, Group
from rest_framework import serializers


class UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ['url', 'username', 'email', 'groups']


class GroupSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Group
        fields = ['url', 'name']

Viewsの設定

先程用意したSerializersを使ってViewsを用意していきます。
（基本的な動作はこのViewsに記述していきます。）
myappフォルダ配下にある「views.py」に記述して下さい。

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from rest_framework import permissions
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer
    permission_classes = [permissions.IsAuthenticated]


class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows groups to be viewed or edited.
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer
    permission_classes = [permissions.IsAuthenticated]

URLsの設定

Viewsで設定した動作をどのURLに割り当てるか設定します。
myprojectフォルダ配下の「urls.py」に記述してください。
（myappフォルダ配下に「urls.py」を生成してmyprojectフォルダ配下の「urls.py」で呼び出しても大丈夫です。）

from django.urls import include, path
from rest_framework import routers
from tutorial.quickstart import views

router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)

# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    path('', include(router.urls)),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

試しにユーザー一覧を取得してみる

まずはサーバーを起動します。

python manage.py runserver

今回はcurlを使って情報を取得してみます。

curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/

Windowsのpowershellを使う場合は以下のコマンドで実行できます。

curl.exe -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/

レスポンス

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "email": "admin@example.com",
            "groups": [],
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin"
        },
    ]
}

こんな感じのレスポンスが返ってくれば成功です。