JSON 验证错误

本课属于 Coddy Django 学习旅程的“JSON API”单元。第 7 课，共 19 课。

现在，缺少标题的 POST 请求会因 KeyError 而崩溃，Django 会返回 500 服务器错误，这并没有告诉程序需要修复什么。

如果问题出在数据上，就返回 400 错误请求，并在 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.loads 时捕获 json.JSONDecodeError，并返回 {"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))