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

前回はクイックスタートで簡単に「DjangoRESTframework」の使い方を学んでいきました。

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

Djangoを使ってRESTAPIサーバーを構築する時によく利用される「DjangoRESTframeworlk」の使い方を公式ドキュメントに沿って解説していきます。必要なライブラリのインストールpip install d...

mofumofu-tips.com

2021.08.10

今回は、公式ドキュメントのチュートリアルに沿って「Tutorial 1: Serialization」について解説していきたいと思います。
チュートリアルを簡単に日本語訳したものになりますので、英語に抵抗がない方は公式ドキュメントを参考にすることをお勧めします。
本記事の目的は「DjangoRESTframework」の入門編として読み物的な感じで読んでいただけますと幸いです。

環境構築

クイックスタートで利用していた環境でも大丈夫ですし、新しく環境講師くしても大丈夫です。
環境構築の方法は個人差があると思いますが、今回は公式チュートリアルに沿ってvenvを使ってやっていきましょう。

python -m venv myenv

（Windows：PowerShell）
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Force
myenv\Scripts\activate.ps1

（mac or linux）
source myenv/bin/activate

成功するとターミナルの頭に(myenv)の文字が出てくるかと思います。
（Windowsの方でうまくいかないという方はこの辺りの記事を参考にしてみてください。）

仮想環境の準備ができましたら必要なライブラリをインストールしていきます。

pip install django
pip install djangorestframework
pip install pygments

pygmentsは直接的には関係ないのですが、今回のチュートリアルのサンプルアプリで使うのでインストールしておいてください。

基本設定

環境構築ができましたので、コーディングを始めていきましょう。
まずは、新しいプロジェクトを作成します。

django-admin startproject tutorial
cd tutorial

プロジェクトの作成ができましたら、次はアプリを作成します。

python manage.py startapp snippets

settings.pyにrest_frameworkとsnippetsを追加していきます。

INSTALLED_APPS = [
    ...
    'rest_framework',
    'snippets,
]

公式チュートリアルの方では'snippets.apps.SnippetsConfig'となっていますが、どっちでもいいです。

Modelsの作成

今回は、コードスニペットを格納するための簡単なモデルを作成しておきます。
使用感を感じてもらうことが本記事の目的なのでコードの細かい説明は省略させていただきます。

from django.db import models
from pygments.lexers import get_all_lexers
from pygments.styles import get_all_styles

LEXERS = [item for item in get_all_lexers() if item[1]]
LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
STYLE_CHOICES = sorted([(item, item) for item in get_all_styles()])


class Snippet(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100, blank=True, default='')
    code = models.TextField()
    linenos = models.BooleanField(default=False)
    language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
    style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)

    class Meta:
        ordering = ['created']

コピペしていただきましたら、次にmigrateしていきましょう。

python manage.py makemigrations snippets
python manage.py migrate

Serializerクラスの作成

APIリクエストが来た時にJSONなどでレスポンスを返すかと思いますが、その辺りの設定をするのがこのSerializerクラスです。
snippetsフォルダ配下にserializers.pyを生成して、以下のコードを張り付けてください。

from rest_framework import serializers
from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES


class SnippetSerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True)
    title = serializers.CharField(required=False, allow_blank=True, max_length=100)
    code = serializers.CharField(style={'base_template': 'textarea.html'})
    linenos = serializers.BooleanField(required=False)
    language = serializers.ChoiceField(choices=LANGUAGE_CHOICES, default='python')
    style = serializers.ChoiceField(choices=STYLE_CHOICES, default='friendly')

    def create(self, validated_data):
        """
        スニペット作成時にバリデートされたデータを返す
        """
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        アップデート時や、すでに存在しているスニペットのバリデートデータを返す
        """
        instance.title = validated_data.get('title', instance.title)
        instance.code = validated_data.get('code', instance.code)
        instance.linenos = validated_data.get('linenos', instance.linenos)
        instance.language = validated_data.get('language', instance.language)
        instance.style = validated_data.get('style', instance.style)
        instance.save()
        return instance

最初の部分はSerializerクラスのシリアル化・逆シリアル化されるフィールドを定義しています。
Formクラスに似ているのでそこまで違和感なく読めるかと思います。

シリアライザーを触ってみる

Djangoシェルを立ち上げて先程定義したシリアライザーを呼び出してみましょう。

python manage.py shell

Djangoシェルが立ち上がりましたら、いくつかのテスト用コードスニペットを作成しましょう。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

snippet = Snippet(code='foo = "bar"\n')
snippet.save()

snippet = Snippet(code='print("hello, world")\n')
snippet.save()

いくつかサンプルデータを流し込みましたら実際に呼び出してみましょう。

serializer = SnippetSerializer(snippet)
serializer.data
# {'id': 2, 'title': '', 'code': 'print("hello, world")\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}

成功するとコメントアウト部分が出力されます。
このデータをレンダリングしてシリアル化プロセスを完了させてみましょう。

content = JSONRenderer().render(serializer.data)
content
# b'{"id": 2, "title": "", "code": "print(\\"hello, world\\")\\n", "linenos": false, "language": "python", "style": "friendly"}'

逆にデシリアライズもしてみましょう。

import io

stream = io.BytesIO(content)
data = JSONParser().parse(stream)
serializer = SnippetSerializer(data=data)
serializer.is_valid()
# True
serializer.validated_data
# OrderedDict([('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])
serializer.save()
# <Snippet: Snippet object>

モデルインスタンスのオブジェクトの他にクエリセットをそのままシリアル化することも可能です。
クエリセットをシリアル化する場合は、シリアライザー関数の引数にmany=Trueを追加してください。

serializer = SnippetSerializer(Snippet.objects.all(), many=True)
serializer.data
# [OrderedDict([('id', 1), ('title', ''), ('code', 'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', ''), ('code', 'print("hello, world")'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])]

ModelSerializersを使ってみる

DjangoではFormクラスとModelFormクラスの両方がサポートされていますが、DjangoRESTframeworkでは、SerializerクラスとModelSerializerクラスの両方がサポートされています。
先程snippets/serializers.pyでコーディングした内容を下記のように書き直すことができます。

from rest_framework import serializers
from snippets.models import Snippet

class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ['id', 'title', 'code', 'linenos', 'language', 'style']

書き直せましたら、保存してDjangoシェルから呼び出してみましょう。

from snippets.serializers import SnippetSerializer
serializer = SnippetSerializer()
print(repr(serializer))
# SnippetSerializer():
#    id = IntegerField(label='ID', read_only=True)
#    title = CharField(allow_blank=True, max_length=100, required=False)
#    code = CharField(style={'base_template': 'textarea.html'})
#    linenos = BooleanField(required=False)
#    language = ChoiceField(choices=[('Clipper', 'FoxPro'), ('Cucumber', 'Gherkin'), ('RobotFramework', 'RobotFramework'), ('abap', 'ABAP'), ('ada', 'Ada')...
#    style = ChoiceField(choices=[('autumn', 'autumn'), ('borland', 'borland'), ('bw', 'bw'), ('colorful', 'colorful')...

このようにModelSerializerクラスを使えば簡単なシリアライザーであれば少ないコードで実装が可能です。
ModelSerializerクラスでは、

• フィールドのセット
• create()およびupdate()メソッドをデフォルトで実装
  をしてくれます。

Viewsを作成していく

Serializerクラスを使用してAPIViewを作成していきましょう。
snippets/views.pyファイルを編集し、以下を追加します。

from django.http import HttpResponse, JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.parsers import JSONParser
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

@csrf_exempt
def snippet_list(request):
    """
    スニペットの一覧の取得と、新規スニペットの追加
    """
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return JsonResponse(serializer.data, safe=False)

    elif request.method == 'POST':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data, status=201)
        return JsonResponse(serializer.errors, status=400)

@csrf_exempt
def snippet_detail(request, pk):
    """
    スニペットの詳細取得、更新、削除
    """
    try:
        snippet = Snippet.objects.get(pk=pk)
    except Snippet.DoesNotExist:
        return HttpResponse(status=404)

    if request.method == 'GET':
        serializer = SnippetSerializer(snippet)
        return JsonResponse(serializer.data)

    elif request.method == 'PUT':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(snippet, data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data)
        return JsonResponse(serializer.errors, status=400)

    elif request.method == 'DELETE':
        snippet.delete()
        return HttpResponse(status=204)

7行目にある@csrf_exemptは、CSRFトークンを持たないクライアントからこのViewにPOSTできるようにするためのデコレータです。
これがないと、フロントエンドを別言語で実装した時にエラーになってします。

（Djangoでは、デフォルトでCSRFトークンを発行しPOSTメソッドの時はそれを確認するようになっていますので、むやみやたらに@csrf_exemptを使わないようにしましょう。）

Urlsの設定

Viewの設定ができましたら、最後にViewをどのURLに割り振るか設定していきましょう。
これは、普段のDjangoの開発と一緒です。
まずは、snippets/urls.pyを作成し、以下の内容をコピペします。

from django.urls import path
from snippets import views

urlpatterns = [
    path('snippets/', views.snippet_list),
    path('snippets/<int:pk>/', views.snippet_detail),
]

次に、tutorial/urls.pyを編集していきます。

from django.urls import path, include

urlpatterns = [
    path('', include('snippets.urls')),
]

これで、一通りの機能を実装することができました。

WebAPIでのテスト

まずは、Djangoシェルを終了します。

quit()

終了できましたら、サーバーを起動します。

python manage.py runserver

Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).
August 12, 2021 - 12:13:06
Django version 3.2.6, using settings 'tutorial.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.

これで簡易的なサーバーが立ち上がりましたので、ターミナルで別タブを開きテストしていきましょう。
テストは、curlやpostmanなどお好きな方法で行っていただいて大丈夫すが今回は、httpieを使ってテストしていきます。
まずはインストール。

pip install httpie

インストールできましたらテストしていきましょう。
まずは、一覧の取得からやっていきます。

http http://127.0.0.1:8000/snippets/

HTTP/1.1 200 OK
...
[
  {
    "id": 1,
    "title": "",
    "code": "foo = \"bar\"\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  },
  {
    "id": 2,
    "title": "",
    "code": "print(\"hello, world\")\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  }
]

次に、詳細を取得してみます。

http http://127.0.0.1:8000/snippets/2/

HTTP/1.1 200 OK
...
{
  "id": 2,
  "title": "",
  "code": "print(\"hello, world\")\n",
  "linenos": false,
  "language": "python",
  "style": "friendly"
}

こんな感じのレスポンスが返ってきていればテスト完了です。
他にも、いろいろ試してみると面白いと思いますので試してみてください。

まとめ

今回は、シリアライザーについての解説になりました。
次回以降もっと実践的な内容になっていきます。

不明点等ございましたら、コメントかTwitterのDMでご質問ください。

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

前回はserializationについて「DjangoRESTframework」の使い方を学んでいきました。今回は、公式ドキュメントのチュートリアルに沿って「 Tutorial 2: Requests and Responses」につい...

mofumofu-tips.com

2021.08.23

Pythonを学びたい方におすすめの書籍