Errores de validación de JSON

Parte de la sección API JSON del Journey de Django de Coddy. Lección 7 de 19.

Ahora mismo, un POST sin título falla con KeyError, y Django responde 500 Error del servidor, lo que no le dice al programa qué debe corregir.

Cuando el problema está en los datos, responde 400 Solicitud incorrecta e indica en JSON qué está mal, con un mensaje por campo, tal como un formulario de Django conserva sus errores. Una librería que comprueba el año de un libro:

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)

Quedan dos trampas. Un título que solo contiene espacios no está vacío, pero " ".strip() es "". Y un cuerpo que no sea JSON hace que json.loads genere json.JSONDecodeError, que try y except convierten en un 400. Un estado 4xx significa que quien hizo la solicitud envió algo incorrecto; un 5xx significa que tu código falló.

Desafío

Intermedio

Haz que POST /api/tasks/ responda con 400 cuando los datos no sean válidos:

Sin título o solo con espacios: {"errors": {"title": "This field is required."}}, y no se guarda nada.
Un cuerpo que no sea JSON: {"error": "The body is not valid JSON."}.
Un título válido se guarda sin los espacios que lo rodean.

Pulsa Run y, después, en la pestaña Shell: from django.test import Client; print(Client().post("/api/tasks/", {"title": " "}, content_type="application/json").json())

Pruébalo tú mismo

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