タスクの削除
CoddyのDjangoジャーニー「JSON API」セクションの一部。レッスン 10/19。
完了したタスクは、チェックを付けるだけでなく削除されるべきです。DELETE /api/tasks/1/ はタスク 1 を削除し、返すものは何もなくなります。
そのために HTTP には 204 No Content があります。リクエストは成功し、レスポンスに本文はありません。JsonResponse は常に本文を書き込み、{} であっても同様です。ステータスだけを指定した通常の HttpResponse は、それ以外は何も送信しません。
def mark_read(request, pk):
Notification.objects.filter(pk=pk).update(read=True)
return HttpResponse(status=204)404 のチェックを最初に行い、存在しないタスクを削除しようとした場合も 404 を返すようにします。
1 つの URL に 3 つのメソッドがあります。GET はタスクを読み取り、PATCH は変更し、DELETE は削除します。リソースごとに URL を用意し、メソッドを動詞として使う API を REST API と呼びます。
チャレンジ
簡単DELETE /api/tasks/<id>/でプログラムからタスクを削除できるようにします。tasks/views.pyで、task_detailに"DELETE"を許可し、その後タスクを削除して、ステータス204と空の本文を返します。タスクが見つからない場合は、引き続き404を返します。
Shellタブで下の行を2回実行します。タスク1はすでに削除されているため、204、続いて404が出力されます。
from django.test import Client; print(Client().delete("/api/tasks/1/").status_code)自分で試してみよう
import json
from django.http import JsonResponse
from django.shortcuts import render
from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_GET, require_http_methods
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()})
@require_GET
def stats(request):
data = {
"total": Task.objects.count(),
"done": Task.objects.filter(done=True).count(),
}
return JsonResponse(data)
@csrf_exempt
@require_http_methods(["GET", "POST"])
def task_list(request):
if request.method == "POST":
try:
data = json.loads(request.body)
except json.JSONDecodeError:
return JsonResponse({"error": "The body is not valid JSON."}, status=400)
errors = {}
title = data.get("title", "").strip()
if not title:
errors["title"] = "This field is required."
if errors:
return JsonResponse({"errors": errors}, status=400)
task = Task.objects.create(
title=title,
priority=data.get("priority", "normal"),
)
return JsonResponse(task_to_dict(task), status=201)
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)
@csrf_exempt
@require_http_methods(["GET", "PATCH"])
def task_detail(request, pk):
task = Task.objects.filter(pk=pk).first()
if task is None:
return JsonResponse({"error": "Task not found"}, status=404)
if request.method == "PATCH":
data = json.loads(request.body)
if "title" in data:
task.title = data["title"]
if "done" in data:
task.done = data["done"]
task.save()
return JsonResponse(task_to_dict(task))
JSON APIのすべてのレッスン
自分で練習してみよう: Djangoプレイグラウンド