שגיאות אימות JSON

חלק מהיחידה ממשקי API של JSON במסלול ה-Django של Coddy. שיעור 7 מתוך 19.

כרגע, בקשת POST ללא כותרת גורמת לקריסה עם KeyError, ו-Django מחזיר 500 Server Error, שלא מסביר לתוכנית מה צריך לתקן.

כשהבעיה היא בנתונים, יש להחזיר 400 Bad Request ולציין ב-JSON מה לא תקין, הודעה אחת לכל שדה, כפי שטופס של Django שומר את השגיאות שלו. לדוגמה, חנות ספרים בודקת את שנת ההוצאה של ספר:

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)

נותרו שתי מלכודות. כותרת שמכילה רק רווחים אינה ריקה, אבל " ".strip() היא "". גוף שאינו JSON גורם ל-json.loads להעלות json.JSONDecodeError. יש לתפוס את החריגה באמצעות try ו-except, ולהחזיר 400 במקום לקרוס.

אתגר

בינוני

גרמו ל־POST /api/tasks/ לדחות נתונים שגויים עם סטטוס 400.

ב־task_list, תפסו את json.JSONDecodeError סביב json.loads והשיבו עם {"error": "The body is not valid JSON."}.
אם הכותרת חסרה או ריקה לאחר הסרת הרווחים, אל תשמרו דבר והשיבו עם {"errors": {"title": "This field is required."}}.
אחרת, צרו את המשימה עם הכותרת לאחר הסרת הרווחים.

בלשונית Shell, השורה שלהלן מדפיסה This field is required.

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

נסו בעצמכם

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