Alterando com PATCH

Parte da seção APIs JSON do Journey de Django da Coddy. Lição 9 de 19.

Um programa marca uma tarefa como concluída enviando {"done": true} para a URL da tarefa, e nada mais. Essa URL representa a própria tarefa, um recurso, e o método diz o que fazer com ela: GET a lê, PATCH altera parte dela. Seu equivalente PUT substitui o recurso inteiro.

Assim, uma view PATCH altera apenas os campos no corpo da requisição. Um valor padrão é a armadilha. Em uma API de livraria:

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

Um programa que envia apenas {"available": false} apaga o título. Primeiro, verifique se a chave foi enviada: "title" in data só é True nesse caso. Defina cada campo presente, salve uma vez e responda com o objeto alterado. A view precisa de @csrf_exempt e do novo método em require_http_methods, como em task_list.

Desafio

Médio

Permita que os programas alterem uma tarefa com PATCH /api/tasks/<id>/:

task_detail aceita GET e PATCH, e é @csrf_exempt.
O PATCH define title e done somente quando eles estão no corpo da requisição, salva e responde com a tarefa.
Uma tarefa inexistente ainda retorna 404.

Clique em Run e, em seguida, na aba Shell: from django.test import Client; print(Client().patch("/api/tasks/1/", {"done": True}, content_type="application/json").json())

Experimente você mesmo

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