チュートリアル1:シリアル化

緒論

このチュートリアルでは、単純にハイライト表示される菜豆コードについて説明します.
このプロセスでは、RESTフレームワークを構成するさまざまなコンポーネントについて説明し、すべてのコンポーネントがどのように組み合わされているかを全面的に理解します.
チュートリアルはかなり深いので、始める前にクッキーと好きなビールを持っていく必要があります.すばやく参照するには、Quickstartドキュメントに移動します.
注意:このマニュアルのコードは、GitHubのencode / rest-framework-tutorialリポジトリにあります.完了したインプリメンテーションは、オンライン砂箱バージョンであり、試験使用ここです。に提供される.

優先パラメータ

python -m venv env
source env/Scripts/activate (windows)
or
source env/bin/activate (linux)
パッケージのインストール
pip install django
pip install djangorestframework
pip install pygments#コードハイライト表示用

開始します。

cd ~
django-admin startproject tutorial
cd tutorial
python manage.py startapp snippets
ここまでよくできていますか.
では、以下ではSnippetsアプリケーションをハンドヘルドアプリケーションに登録します.

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

もう転がる準備ができています.

モデルの作成

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

Serializerクラスの作成

jsonにするには、snippetインスタンスをシーケンス化および逆シーケンス化する必要があります.特にSerializer宣言とdjango formの動きは似ています
シリアル化と逆シリアル化の概念
まず、次のように書類を書きます.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

serializerクラスは、まずシーケンス化/逆シーケンス化フィールドを定義します.create()とupdate()メソッドはシーケンス化器です.save()を呼び出すときに完全なインスタンスを作成または変更する方法を定義します.
Serializerと
required、max length、defaultなど多くの検証フラグの特徴.
HTMLアップロード時でも、これらのフィールドタグはシーケンス化を制御します.
上の{'base_template': 'textarea.html'}flagは、「ロングフォーマット」クラスのwidget=widgets.Textareaと同じです.チュートリアルでは見られますが、browsable APIに表示される場合、特に便利に制御できます.

シリアル化の使用

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

シリアル化を表示するには、snippetインスタンスを使用します.

serializer = SnippetSerializer(snippet)
serializer.data
# {'id': 2, 'title': '', 'code': 'print("hello, world")

上はPythonデータ型bytesに変更し、最後にdata JSON化しました.

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

逆シーケンス化も同様です.まずstreamをPython固有データ型に分けます.

import io

stream = io.BytesIO(content)
stream
#  <_io.BytesIO at 0x262860bcb30>

data = JSONParser().parse(stream)
data
#{'id': 3,
# 'title': '',
# 'code': 'print("안녕! 내이름은 이혜성이야")\n',
# 'linenos': False,
# 'language': 'python',
# 'style': 'friendly'} 

次に、Pythonデータ型をオブジェクトインスタンスとして保存します.

serializer = SnippetSerializer(data=data)
serializer.is_valid()
# True
serializer.validated_data
#OrderedDict([('title', ''),
#             ('code', 'print("안녕! 내이름은 이혜성이야")'),
#             ('linenos', False),
#             ('language', 'python'),
#             ('style', 'friendly')])
serializer.save()
# <Snippet: Snippet object>

APIは本当にformsと似ています.特に、ビューを作成するときに、その類似性がより明確であると判断できます.
モデルinstanceではなくquersetをシリアル化することもできます.SnippetSerialzer()クラスのキーワードパラメータとしてmany=Trueflagを簡単に使用すればよい.

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

ModelSerializerの使用

Snippet Serializerクラスは、Snippetモデルに含まれる多くの情報をコピーします.
ModelSerializerはコードをより簡潔にします.
DjangoがFormクラスとModelFormクラスを提供する方法と同様に、RESTフレームワークにはSerializerクラスとModelSerializerクラスが同時に含まれる.
ModelSerializerクラスを使用して再パッケージします.snippets/serializers.pyを開きます.次にSnippetSerializerclassを以下に示す.

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

serializerには、serializerインスタンス内のすべてのフィールドをチェックするために表現を出力できる良いプロパティがあります.

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クラスはserializerクラスを作成する近道にすぎません.

自動決定フィールドセット

create()およびupdate()メソッドの簡単な基本実装

通常のフェイルオーバビューを使用してシリアル化器を作成するには

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
The root of our API is going to be a view that supports listing all the existing snippets, or creating a new snippet.

@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 exiftとマークする必要がある.
また、単一のクエリーと変更または削除に対応するsnippetを作成します.

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

上のviewの仕事を終わらせましょう先に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のsnippetをURLに含めるには、プロジェクトフォルダのurlconfに接続する必要があります.

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

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

]

今書いてある通りにすれば、処理できないことがいくつかあります.jsonフォーマットエラーまたはビューで未処理のリクエストの場合.その場合、通常500個のエラーが吐き出されますが.今から始めよう(勉強のために)

WEB APIテストの最初の試み

Shellを開いたら閉じてサーバーをアップロードしてください.curlorhttpieを使用して練習します.ちなみにHttpieはPythonでユーザーフレンドリーなhttpclientのために作られています
敷設されていない場合は、取り付けてください.

pip install httpie

端末で次のコマンドを入力すると応答が受信されます.

❯ http http://127.0.0.1:8000/snippets/
HTTP/1.1 200 OK
Content-Length: 413
Content-Type: application/json
Date: Thu, 18 Feb 2021 18:59:47 GMT
Referrer-Policy: same-origin
Server: WSGIServer/0.2 CPython/3.9.1
X-Content-Type-Options: nosniff
X-Frame-Options: DENY

[
    {
        "code": "foo = \"bar\"\n",
        "id": 1,
        "language": "python",
        "linenos": false,
        "style": "friendly",
        "title": ""
    },
    {
        "code": "print(\"hello, world\")\n",
        "id": 2,
        "language": "python",
        "linenos": false,
        "style": "friendly",
        "title": ""
    },
    {
        "code": "print(\"안녕! 내이름은 이혜성이야\")\n",
        "id": 3,
        "language": "python",
        "linenos": false,
        "style": "friendly",
        "title": ""
    }
]

ショートメッセージで呼びましょうか?

❯ http http://127.0.0.1:8000/snippets/1/
HTTP/1.1 200 OK
Content-Length: 110
Content-Type: application/json
Date: Thu, 18 Feb 2021 19:09:08 GMT
Referrer-Policy: same-origin
Server: WSGIServer/0.2 CPython/3.9.1
X-Content-Type-Options: nosniff
X-Frame-Options: DENY

{
    "code": "foo = \"bar\"\n",
    "id": 1,
    "language": "python",
    "linenos": false,
    "style": "friendly",
    "title": ""
}

n/a.結論

これまで、DjangoのForms APIと、通常のDjango viewに似たシーケンス化APIを問題なく作成してきました.
現在作成されているAPIは、応答を提供する以外に、特別な操作を実行しません.まだ処理したいエラー処理部分がありますが、スクロールするWeb APIです.jsonは、より高いレベルの補助機能を提供します.