Erros de validação de JSON
Parte da seção APIs JSON do Journey de Django da Coddy. Lição 7 de 19.
No momento, uma requisição POST sem título causa um erro KeyError, e o Django responde com 500 Server Error, que não informa ao programa o que precisa ser corrigido.
Quando o problema está nos dados, responda com 400 Bad Request e informe em JSON o que está errado, com uma mensagem por campo, da mesma forma que um formulário do Django mantém seus erros. Uma livraria verificando o ano de um livro:
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)Ainda há duas armadilhas. Um título composto apenas por espaços não está vazio, mas " ".strip() resulta em "". Um corpo que não esteja em JSON faz com que json.loads gere json.JSONDecodeError. Capture esse erro com try e except e responda com 400 em vez de causar uma falha.
Desafio
MédioFaça com que POST /api/tasks/ recuse dados inválidos com o status 400.
- Em
task_list, capturejson.JSONDecodeErrorem torno dejson.loadse responda com{"error": "The body is not valid JSON."}. - Se o título estiver ausente ou em branco depois de remover os espaços em branco, não salve nada e responda com
{"errors": {"title": "This field is required."}}. - Caso contrário, crie a tarefa com o título sem espaços em branco nas extremidades.
Na aba Shell, a linha abaixo imprime Este campo é obrigatório.
from django.test import Client; print(Client().post("/api/tasks/", {"title": " "}, content_type="application/json").json())Experimente você mesmo
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))
Todas as lições de APIs JSON
2Lendo requisições
Filtrando com uma consultaCriando com POST5Projeto: Organizando o Trabalho
Projeto: PrioridadesProjeto: Limpar Tarefas ConcluídasPratique por conta própria: Playground de Django