Błędy walidacji JSON

Część sekcji API JSON ścieżki Django w Coddy. Lekcja 7 z 19.

Obecnie żądanie POST bez tytułu powoduje błąd KeyError, a Django zwraca 500 Błąd serwera, co nie mówi programowi, co należy poprawić.

Gdy problem dotyczy danych, zwróć 400 Nieprawidłowe żądanie i opisz w JSON, co jest nie tak — po jednym komunikacie dla każdego pola, tak jak formularz Django przechowuje błędy. Przykład: księgarnia sprawdza rok wydania książki:

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)

Pozostają jeszcze dwie pułapki. Tytuł zawierający same spacje nie jest pusty, ale " ".strip() daje "". A jeśli treść żądania nie jest w formacie JSON, json.loads zgłasza wyjątek json.JSONDecodeError, który try i except zamieniają w odpowiedź 400. Status 4xx oznacza, że wywołujący wysłał coś nieprawidłowego; status 5xx oznacza, że Twój kod nie działa.

Wyzwanie

Średni

Spraw, aby POST /api/tasks/ zwracało 400 w przypadku nieprawidłowych danych:

Brak tytułu lub same spacje: {"errors": {"title": "This field is required."}}, nic nie zostaje zapisane.
Treść, która nie jest JSON-em: {"error": "The body is not valid JSON."}.
Prawidłowy tytuł zostaje zapisany bez otaczających go spacji.

Naciśnij Run, a następnie w karcie Shell: from django.test import Client; print(Client().post("/api/tasks/", {"title": " "}, content_type="application/json").json())

Spróbuj swoich sił

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