Erros de validação de JSON

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

No momento, uma requisição POST sem título causa uma falha com KeyError, e o Django responde 500 Server Error, o que não informa ao programa o que deve ser corrigido.

Quando o problema está nos dados, responda com 400 Bad Request e informe o que está errado em JSON, com uma mensagem por campo, como um formulário do Django mantém seus erros. Uma livraria verificando o ano de um livro:

errors = {}
year = data.get("year")
if not isinstance(year, int) or year < 0:
    errors["year"] = "Enter the year as a whole number."
if errors:
    return JsonResponse({"errors": errors}, status=400)

Restam duas armadilhas. Um título composto apenas por espaços não está vazio, mas " ".strip() é "". E um corpo que não está em JSON faz json.loads gerar json.JSONDecodeError, que try e except transformam em um erro 400. Um status 4xx significa que quem fez a chamada enviou algo errado; um 5xx significa que seu código falhou.

Desafio

Médio

Faça com que POST /api/tasks/ retorne 400 para dados inválidos:

Sem título ou apenas espaços: {"errors": {"title": "This field is required."}}, e nada será salvo.
Um corpo que não seja JSON: {"error": "The body is not valid JSON."}.
Um título válido é salvo sem os espaços ao redor.

Pressione Executar e, em seguida, na aba Shell: from django.test import Client; print(Client().post("/api/tasks/", {"title": " "}, 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 .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()})


def stats(request):
    data = {
        "total": Task.objects.count(),
        "done": Task.objects.filter(done=True).count(),
    }
    return JsonResponse(data)


@csrf_exempt
def task_list(request):
    if request.method == "POST":
        data = json.loads(request.body)
        task = Task.objects.create(
            title=data["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)


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