POSTで作成する
CoddyのDjangoジャーニー「JSON API」セクションの一部。レッスン 5/19。
プログラムはタスクを読み取れますが、追加はできません。作成するには、プログラムはタスクをJSONとしてリクエストのbody(リクエストとともに送信されるデータ)に含め、リストのURLにPOSTを送信します。フォームのデータはrequest.POSTに入りますが、JSONは入りません。生の本文であるrequest.bodyを読み取り、json.loadsでPythonのデータに変換します。
request.methodによって処理を切り替えれば、1つのURLで2つの役割を果たせます。このビューは、送られてきた内容をそのまま返すだけです。
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を取得できます。プログラムが省略する可能性のあるキーは、デフォルト値を指定して読み取ります。例:data.get("colour", "black")。
チャレンジ
中級POST /api/tasks/を使ってプログラムからタスクを作成できるようにします。
{"title": "Pay rent", "priority": "high"}のようなJSON本文を読み取り、タスクを作成します。priorityが指定されていない場合は、"normal"になります。- 新しいタスクとステータス
201を返します。 - GETでは引き続き一覧表示と絞り込みを行います。
アドレスバーから送信できるのはGETだけです。「Run」を押してから、「Shell」タブに次のように入力します。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))
このレッスンには短いクイズがあります。レッスンを始めて解答し、進捗を記録しましょう。
JSON APIのすべてのレッスン
自分で練習してみよう: Djangoプレイグラウンド