JSONのバリデーションエラー

CoddyのDjangoジャーニー「JSON API」セクションの一部。レッスン 7/19。

現時点では、タイトルのない POST を送ると KeyError でクラッシュし、Django は 500 Server Error を返します。これでは、何を修正すればよいのかプログラムに何も伝わりません。

データに問題がある場合は、400 Bad Request を返し、Django のフォームがエラーを保持する方法と同じように、フィールドごとに1つのメッセージを JSON で伝えましょう。本屋で本の出版年を確認する例です。

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)

注意点が2つあります。スペースだけのタイトルは空ではありませんが、" ".strip() は "" になります。また、JSON ではない本文を渡すと、json.loads は json.JSONDecodeError を発生させます。これは try と except によって 400 に変換できます。4xx ステータスは呼び出し元が誤ったものを送ったことを意味し、5xx はコードに問題が起きたことを意味します。

チャレンジ

中級

不正なデータの場合、POST /api/tasks/ が 400 を返すようにします。

タイトルがない、または空白のみの場合: {"errors": {"title": "This field is required."}}。何も保存されません。
本文がJSONではない場合: {"error": "The body is not valid JSON."}。
有効なタイトルは、前後の空白を取り除いて保存されます。

Runを押してから、Shellタブで次を実行します: 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))