Menu
CoddyTech

JSON 유효성 검사 오류

Coddy Django 여정의 JSON API 섹션에 포함된 레슨. 19개 중 7번째.

현재 제목이 없는 POST 요청은 KeyError로 인해 충돌하고, Django는 500 서버 오류로 응답하므로 프로그램은 무엇을 수정해야 하는지 알 수 없습니다.

데이터에 문제가 있을 때는 400 잘못된 요청으로 응답하고, Django 양식이 오류를 저장하는 방식처럼 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)

두 가지 함정이 더 있습니다. 공백만 있는 제목은 비어 있지 않지만, " ".strip()은 ""입니다. JSON이 아닌 본문을 받으면 json.loads가 json.JSONDecodeError를 발생시킵니다. try와 except로 이를 처리하고, 충돌하는 대신 400으로 응답하세요.

challenge icon

챌린지

중급

POST /api/tasks/가 잘못된 데이터를 상태 코드 400으로 거부하도록 하세요.

  1. task_list에서 json.loads를 둘러싼 json.JSONDecodeError를 처리하고 {"error": "The body is not valid JSON."}으로 응답하세요.
  2. 제목이 없거나 공백을 제거한 뒤 비어 있으면 아무것도 저장하지 말고 {"errors": {"title": "This field is required."}}로 응답하세요.
  3. 그렇지 않으면 공백을 제거한 제목으로 항목을 생성하세요.

셸 탭에서 아래 줄을 실행하면 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))

JSON API의 모든 레슨

직접 연습해 보세요: Django 플레이그라운드