Errori di convalida JSON

Fa parte della sezione API JSON del percorso Django di Coddy. Lezione 7 di 19.

Al momento, una richiesta POST senza titolo causa un errore KeyError e Django risponde con 500 Errore del server, senza dare al programma alcuna indicazione su cosa correggere.

Quando il problema riguarda i dati, rispondi con 400 Richiesta non valida e indica in JSON cosa non va, con un messaggio per campo, come fa un modulo Django con i propri errori. Una libreria che controlla l’anno di 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)

Restano due insidie. Un titolo composto solo da spazi non è vuoto, ma " ".strip() è "". E un corpo che non è JSON fa sì che json.loads sollevi json.JSONDecodeError, che try e except trasformano in una risposta 400. Un codice di stato 4xx significa che il chiamante ha inviato qualcosa di errato; un codice 5xx significa che il tuo codice ha avuto un problema.

Sfida

Medio

Fai in modo che POST /api/tasks/ risponda con 400 in caso di dati non validi:

Nessun titolo o solo spazi: {"errors": {"title": "This field is required."}}, senza salvare nulla.
Un corpo che non è JSON: {"error": "The body is not valid JSON."}.
Un titolo valido viene salvato senza gli spazi che lo circondano.

Premi Esegui, poi nella scheda Shell: from django.test import Client; print(Client().post("/api/tasks/", {"title": " "}, content_type="application/json").json())

Provalo tu

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