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 provoca un error KeyError, y Django responde con Error del servidor 500, lo que no le dice al programa qué debe corregir.

Cuando el problema está en los datos, responde con Solicitud incorrecta 400 e indica en JSON qué está mal, un mensaje por campo, como hace un formulario de Django con 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 casos problemáticos. Un título compuesto solo por espacios no está vacío, pero " ".strip() es "". Un cuerpo que no está en JSON hace que json.loads lance json.JSONDecodeError. Captúralo con try y except, y responde con 400 en lugar de provocar un error.

Desafío

Intermedio

Haz que POST /api/tasks/ rechace los datos incorrectos con el estado 400.

En task_list, captura json.JSONDecodeError alrededor de json.loads y responde con {"error": "The body is not valid JSON."}.
Si falta el título o está en blanco después de eliminar los espacios, no guardes nada y responde con {"errors": {"title": "This field is required."}}.
De lo contrario, créala con el título sin espacios al principio ni al final.

En la pestaña Shell, la línea siguiente imprime This field is required.

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