Änderungen mit PATCH

Teil des Abschnitts JSON-APIs der Django-Journey von Coddy. Lektion 9 von 19.

Ein Programm hakt eine Aufgabe ab, indem es {"done": true} an die URL der Aufgabe sendet, und nichts anderes. Diese URL steht für die Aufgabe selbst, eine Ressource, und die Methode gibt an, was damit geschehen soll: GET liest sie, PATCH ändert einen Teil davon. Das verwandte PUT ersetzt die gesamte Ressource.

Eine PATCH-View ändert also nur die Felder im Body. Ein Standardwert ist die Falle. In einer Buchhandlungs-API:

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

Ein Programm, das nur {"available": false} sendet, löscht den Titel. Prüfe zuerst, ob der Schlüssel gesendet wurde: "title" in data ist nur dann True. Setze jedes vorhandene Feld, speichere einmal und antworte mit dem geänderten Objekt. Die View benötigt @csrf_exempt und die neue Methode in require_http_methods, wie bei task_list.

Aufgabe

Mittel

Lass Programme eine Aufgabe mit PATCH /api/tasks/<id>/ ändern:

task_detail akzeptiert GET und PATCH und ist @csrf_exempt.
PATCH setzt title und done nur dann, wenn sie im Body enthalten sind, speichert die Änderungen und gibt die Aufgabe zurück.
Für eine nicht vorhandene Aufgabe wird weiterhin 404 zurückgegeben.

Klicke auf „Run“ und führe dann im Tab „Shell“ Folgendes aus: from django.test import Client; print(Client().patch("/api/tasks/1/", {"done": True}, content_type="application/json").json())

Probier es selbst

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