タスクの削除

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

完了したタスクはチェックを付けるだけでなく、なくなるべきです。DELETE /api/tasks/1/ はタスク 1 を削除するため、送り返すものは何もありません。

そのために HTTP には 204 No Content があります。リクエストは成功し、レスポンス本文はありません。JsonResponse は常に本文を書き込み、{} でさえ書き込みます。ステータスだけを指定した通常の HttpResponse は、それ以外は何も送信しません。

return HttpResponse(status=204)

404 のチェックを先に行うことで、存在しないタスクを削除しようとした場合も 404 を返します。

1 つの URL に 3 つのメソッドがあります。GET はタスクを読み取り、PATCH は変更し、DELETE は削除します。リソースごとに URL を設け、メソッドを動詞として使う API は、REST API と呼ばれます。

チャレンジ

簡単

プログラムから DELETE /api/tasks/<id>/ でタスクを削除できるようにします。

task_detail で "DELETE" を許可します。
タスクを削除し、本文なしで 204 を返します。
タスクが見つからない場合も、引き続き404を返します。

「Run」を押してから、「Shell」タブで次を実行します。from django.test import Client; print(Client().delete("/api/tasks/1/").status_code) は 204 を出力します。

自分で試してみよう

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