POSTで作成する

CoddyのDjangoジャーニー「JSON API」セクションの一部。レッスン 5/19。

プログラムはタスクを読み取れますが、追加はできません。作成するには、プログラムはリストのURLにPOSTを送り、リクエストのbody（リクエストとともに送られるデータ）にタスクをJSONとして含めます。フォームの内容はrequest.POSTに入りますが、JSONは入りません。生のボディであるrequest.bodyを読み取り、json.loadsでPythonのデータに変換します。

1つのURLで、request.methodによって切り替わる2つの処理を行えます。このビューは、送られてきた内容をそのまま返すだけです。

import json


def echo(request):
    if request.method == "POST":
        data = json.loads(request.body)
        return JsonResponse({"you_sent": data})
    return JsonResponse({"hint": "Send me a POST"})

何かを作成するビューは、201 Createdと新しいオブジェクトを返すため、プログラムはそのidを知ることができます。

アドレスバーから送れるのはGETだけなので、「Shell」タブからPOSTを送ってみましょう。Djangoのテスト用ClientはPythonからサイトにリクエストを送り、.json()でレスポンスを読み取ります。Shellでは、JSONのfalseではなく、'done': FalseのようにPythonの辞書として表示されます。

チャレンジ

中級

プログラムでタスクを作成できるようにします。

tasks/views.pyで、import jsonを追加します。task_listの先頭で、POSTの場合に、JSON本文のtitleとpriorityからタスクを作成します（デフォルトはnormal）。
task_to_dictから新しいタスクを返し、ステータスを201にします。その下のGETのコードはそのままにします。

Shellタブで下の行を実行します。優先度がnormalのPay rentが出力されます。

from django.test import Client; print(Client().post("/api/tasks/", {"title": "Pay rent"}, content_type="application/json").json())

自分で試してみよう

from django.http import JsonResponse
from django.shortcuts import render

from .models import Task


def task_to_dict(task):
    return {
        "id": task.id,
        "title": task.title,
        "done": task.done,
        "priority": task.priority,
    }


def home(request):
    return render(request, "tasks/home.html", {"tasks": Task.objects.all()})


def stats(request):
    data = {
        "total": Task.objects.count(),
        "done": Task.objects.filter(done=True).count(),
    }
    return JsonResponse(data)


def task_list(request):
    tasks = Task.objects.all()
    done = request.GET.get("done")
    if done == "true":
        tasks = tasks.filter(done=True)
    elif done == "false":
        tasks = tasks.filter(done=False)
    return JsonResponse([task_to_dict(task) for task in tasks], safe=False)


def task_detail(request, pk):
    task = Task.objects.filter(pk=pk).first()
    if task is None:
        return JsonResponse({"error": "Task not found"}, status=404)
    return JsonResponse(task_to_dict(task))