Menu
CoddyTech

Uma tarefa por ID

Parte da seção APIs JSON do Journey de Django da Coddy. Lição 3 de 19.

Um programa que leu a lista agora quer uma tarefa, em sua própria URL: /api/tasks/1/. A rota recebe o id com <int:pk>, como suas páginas de detalhes faziam, e o auxiliar task_to_dict(task) do projeto inicial transforma uma tarefa em um dicionário.

A novidade é lidar com uma tarefa inexistente. get_object_or_404 responde com a página HTML 404 do Django, que um programa não consegue ler, então uma API também envia seus erros como JSON, com o código de status correto, o número que informa como foi uma solicitação: 200 OK, 403 Proibido, 404 Não Encontrado. JsonResponse recebe esse valor como status:

return JsonResponse({"error": "Staff only"}, status=403)

Para escolher entre o erro e a tarefa, procure a linha sem gerar uma exceção: filter(pk=...).first() retorna a linha ou None quando não há nenhuma.

challenge icon

Desafio

Fácil

Adicione um endpoint para uma tarefa.

  1. Em tasks/views.py, adicione task_detail(request, pk). Ele responde com task_to_dict(task) em JSON. Quando nenhuma tarefa tiver esse id, responda com o status 404 e {"error": "Task not found"}.
  2. Em tasks/urls.py, adicione a rota "api/tasks/<int:pk>/" chamada task_detail.

Acesse /api/tasks/99/: você verá {"error": "Task not found"}.

Experimente você mesmo

from django.http import JsonResponse
from django.shortcuts import render

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)


def task_list(request):
    tasks = Task.objects.values("id", "title", "done", "priority")
    return JsonResponse(list(tasks), safe=False)
quiz iconTeste seus conhecimentos

Esta lição inclui um quiz rápido. Comece a lição para respondê-lo e acompanhar seu progresso.

Todas as lições de APIs JSON

Pratique por conta própria: Playground de Django