PATCHによる変更

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

プログラムは、タスクのURLに{"done": true}だけを送信して、タスクを完了にします。そのURLはタスクそのもの、つまりリソースを表し、メソッドはそのリソースに対して何をするかを示します。GETは読み取り、PATCHは一部を変更します。兄弟のPUTはリソース全体を置き換えます。

つまり、PATCHビューはリクエスト本文にあるフィールドだけを変更します。デフォルト値には落とし穴があります。本屋のAPIでは、次のようになります。

book.title = data.get("title", "")

{"available": false}だけを送信するプログラムは、タイトルを消してしまいます。まず、そのキーが送信されたかどうかを確認しましょう。"title" in dataは、その場合にのみTrueになります。存在する各フィールドを設定し、一度だけ保存して、変更後のオブジェクトを返します。このビューには@csrf_exemptと、task_listにあるように、require_http_methodsに新しいメソッドを追加する必要があります。

チャレンジ

中級

プログラムから PATCH /api/tasks/<id>/ を使ってタスクを変更できるようにします。

task_detail は GET と PATCH を受け付け、@csrf_exempt が指定されています。
PATCH は、リクエスト本文に title と done が含まれている場合にのみそれらを設定し、保存してタスクを返します。
タスクが見つからない場合も、404 を返します。

「Run」を押し、次に「Shell」タブで実行します: from django.test import Client; print(Client().patch("/api/tasks/1/", {"done": True}, content_type="application/json").json())

自分で試してみよう

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)


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