Github 検索 <スパン クラス="icon-bar"> <スパン クラス="icon-bar"> <スパン クラス="icon-bar"> Django REST フレームワーク

チュートリアル 1: シリアライズ

序章

このチュートリアルでは、シンタックスハイライト付きのシンプルなペーストビンコード WebAPI の作成について説明します。その過程でRESTフレームワークを構成するさまざまなコンポーネントを紹介し、それらがどのように連携するかを包括的に理解できます。

チュートリアルは非常に詳細であるため、始める前にクッキーと好きな飲み物を用意する必要があります。簡単な概要だけが必要な場合は、代わりに クイックスタート のドキュメントを参照してください。

注: このチュートリアルのコードは、GitHub の encode/rest-framework-tutorial リポジトリにあります。完了した実装は、テスト用のサンドボックスバージョンとしてオンラインでも利用でき、こちら から利用できます。

新しい環境を設定する

それ以外の場合は、venv を使用して新しい仮想環境を作成します。これにより、パッケージの構成は、他の作業中のプロジェクトから適切に隔離されるようになります。

python3 -m venv env
source env/bin/activate

仮想環境内に入ったため、パッケージ要件をインストールできます。

pip install django
pip install djangorestframework
pip install pygments  # We'll be using this for the code highlighting

注: 仮想環境からいつでも終了する場合は deactivate と入力してください。詳細については、venv ドキュメントを参照してください。

始めよう

それでは、コーディングに取り掛かりましょう。はじめに、作業する新しいプロジェクトを作成しましょう。

cd ~
django-admin startproject tutorial
cd tutorial

完了したら、シンプルな Web API を作成するのに使用するアプリを作成できます。

python manage.py startapp snippets

新しい snippets アプリと rest_framework アプリを INSTALLED_APPS に追加する必要があります。tutorial/settings.py ファイルを編集してみましょう

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

それでは、着手しましょう。

一緒に作業するモデルを作成する

このチュートリアルの目的のために、コードスニペットを格納するために使われる Snippet モデルを最初に作成します。snippets/models.py ファイルを編集してみましょう。注: 優れたプログラミング方法にはコメントが含まれます。このチュートリアルコードのレポジトリバージョンにはありますが、ここではコード自体に集中するため省略しました。

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']

また、スニペットモデルに対する最初のマイグレーションを作成し、データベースを初めて同期する必要があります。

python manage.py makemigrations snippets
python manage.py migrate snippets

シリアライザーを作成する

Web API を始めるにあたって最初にすることは、スニペットインスタンスを json などにシリアル化および逆シリアル化する手段を用意することです。Django のフォームと非常によく似たシリアライザーを宣言することでこれを行うことができます。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):
        """
        Create and return a new `Snippet` instance, given the validated data.
        """
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        Update and return an existing `Snippet` instance, given the 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

シリアライザークラスの最初のパートは、シリアル化/逆シリアル化されるフィールドを定義します。create() および update() メソッドは、 serializer.save() 呼び出し時に完全なインスタンスがどのように作成または変更されるかを定義します

シリアライザークラスは、Django Form クラスと非常によく似ており、required、max_length、default など、さまざまなフィールドに同様の検証フラグが含まれます。

フィールドフラグは、HTML にレンダリングする場合など、シリアライザーを特定の状況でどのように表示するかを制御することもできます。この上記の {'base_template': 'textarea.html'} フラグは、Django の Form クラスで widget=widgets.Textarea を使うのと同じです。これは、このチュートリアルの後半で分かるように、ブラウザー可能な API をどのように表示するかを制御するのに特に役立ちます。

後述のように ModelSerializer クラスを使用することで実際に時間を節約できますが、ここではシリアライザーの定義を明示しておきます。

シリアライザーを操作する

これ以上進む前に、新しいシリアライザークラスの使い方に慣れましょう。Django シェルにドロップしましょう。

python manage.py shell

さあ、インポートをいくつか済ませたら、一緒に作業するコードスニペットをいくつか作成しましょう。

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()

これで、操作するためのスニペットインスタンスがいくつかあります。これらのインスタンスのうち 1 つをシリアル化してみましょう。

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

この時点で、モデルインスタンスを Python ネイティブデータ型に変換しました。シリアル化プロセスを終了するには、データを json にレンダリングします。

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

逆シリアル化も同様です。最初に、ストリームを Python ネイティブデータ型に解析します...

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>

API がフォーム操作と非常に似ていることに注目してください。シリアライザーを使用するビューの記述を開始すると、さらに類似性が明らかになります。

モデルインスタンスではなくクエリセットをシリアル化することもできます。それには、シリアライザー引数に 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 を使用する

SnippetSerializer クラスは、Snippet モデルにも含まれる多くの情報を複製しています。コードをもう少し簡潔にできればよいでしょう。

Django が Form クラスと ModelForm クラスの両方を提供する方法と同じで、REST フレームワークには Serializer クラスと ModelSerializer クラスの両方が含まれています。

ModelSerializerクラスを使用してシリアライザーのリファクタリングを見てみましょう。snippets/serializers.pyファイルを開き、SnippetSerializerクラスを以下に置き換えます。

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

シリアライザーが持つ1つの優れたプロパティは、その表現を出力することでシリアライザーインスタンスのすべてのフィールドを調査できることです。python manage.py shellで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クラスは特に魔法のようなことは行わないという点を覚えておくことが重要です。それらは単にシリアライザーを作成するためのショートカットです

  • 自動的に決定された一連のフィールド。
  • create()およびupdate()メソッドのシンプルなデフォルト実装。

私たちのシリアライザーを使用して通常の Django ビューを書く

新しいシリアライザークラスを使用して一部のAPIビューを記述する方法を見てみましょう。現時点ではRESTフレームワークの他の機能を使用せず、単にビューを通常のDjangoビューとして記述します。

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

APIのルートは、既存のすべてのスニペットをリストするか、新しいスニペットを作成するビューになります。

@csrf_exempt
def snippet_list(request):
    """
    List all code snippets, or create a new snippet.
    """
    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トークンを持たないクライアントからこのビューにPOSTできるようにする必要があるため、ビューをcsrf_exemptとしてマークする必要があることに注意してください。通常はこれを望むことはありませんし、RESTフレームワークのビューは実際にはこれよりも適切な動作を使用しますが、現時点では目的が果たされます。

個々のスニペットに対応し、スニペットを取得、更新、削除するために使用できるビューも必要になります。

@csrf_exempt
def snippet_detail(request, pk):
    """
    Retrieve, update or delete a code snippet.
    """
    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)

最後に、これらのビューを結び付ける必要があります。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),
]

スニペットアプリのURLを含めるために、tutorial/urls.pyファイル内のルートurlconfを接続する必要もあります。

from django.urls import path, include

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

現時点では適切に対処していないエッジケースがいくつかあることに注意してください。不正なjsonを送信した場合、またはビューが処理しないメソッドを使用してリクエストが行われた場合は、500「サーバーエラー」応答が発生します。それでも、現時点ではこれで十分です。

Web API の最初の試みをテストする

スニペットを提供するサンプルサーバーを起動できます。

シェルを終了します...

quit()

...およびDjangoの開発サーバーを起動します。

python manage.py runserver

Validating models...

0 errors found
Django version 4.0, using settings 'tutorial.settings'
Starting Development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

別のターミナルウィンドウで、サーバーをテストできます。

curlまたはhttpieを使用してAPIをテストできます。HttpieはPythonで記述された、ユーザーフレンドリーなhttpクライアントです。インストールしましょう。

pipを使用して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"
  }
]

または、そのidを参照して特定のスニペットを取得できます

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"
}

同様に、WebブラウザでこれらのURLにアクセスすると、同じjsonを表示できます。

どこにいるのか

これまでのところ順調です。DjangoのフォームAPIと非常に類似したシリアライズAPIと、いくつかの通常のDjangoビューができました。

現時点では、APIビューはjson応答を提供する以外には特別なこと何も行わず、まだクリーンアップしたいいくつかのエラー処理エッジケースがありますが、機能するWeb APIです。

チュートリアルの第2部で、どのように改善できるかを見ていきます。