Wprowadzanie zmian za pomocą PATCH

Część sekcji API JSON ścieżki Django w Coddy. Lekcja 9 z 19.

Program odznacza zadanie jako wykonane, wysyłając pod adres URL zadania {"done": true} i nic więcej. Ten adres URL wskazuje samo zadanie, czyli zasób, a metoda określa, co z nim zrobić: GET odczytuje go, PATCH zmienia jego część. Jego odpowiednikiem jest PUT, który zastępuje cały zasób.

Widok PATCH zmienia więc tylko pola z treści żądania. Wartość domyślna jest pułapką. W API księgarni:

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

Program, który wysyła tylko {"available": false}, usuwa tytuł. Najpierw sprawdź, czy klucz został wysłany: "title" in data ma wartość True tylko wtedy. Ustaw każde pole, które występuje, zapisz raz i odpowiedz zmienionym obiektem. Widok wymaga @csrf_exempt i nowej metody w require_http_methods, tak jak task_list.

Wyzwanie

Średni

Pozwól programom zmieniać zadanie za pomocą PATCH /api/tasks/<id>/:

task_detail obsługuje GET i PATCH oraz ma dekorator @csrf_exempt.
PATCH ustawia title i done tylko wtedy, gdy znajdują się one w treści żądania, zapisuje zmiany i zwraca zadanie.
Jeśli zadanie nie istnieje, nadal zwracany jest kod 404.

Naciśnij Run, a następnie w karcie Shell: from django.test import Client; print(Client().patch("/api/tasks/1/", {"done": True}, content_type="application/json").json())

Spróbuj swoich sił

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