Menu
CoddyTech

Excluindo uma tarefa

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

Uma tarefa concluída deve desaparecer, não apenas ser marcada: DELETE /api/tasks/1/ remove a tarefa 1, e então não há nada para enviar de volta.

Para isso, o HTTP tem 204 No Content: a solicitação funcionou e a resposta não tem corpo. Um JsonResponse sempre envia um corpo, até mesmo {}. Um HttpResponse simples, apenas com um status, não envia mais nada:

return HttpResponse(status=204)

Mantenha a verificação de 404 em primeiro lugar, para que a exclusão de uma tarefa inexistente ainda retorne 404.

Uma URL, três métodos: GET lê a tarefa, PATCH a altera, DELETE a remove. Uma URL por recurso, com o método como verbo, é o que as pessoas chamam de API REST.

challenge icon

Desafio

Fácil

Permita que os programas excluam uma tarefa com DELETE /api/tasks/<id>/:

  • Permita "DELETE" em task_detail.
  • Exclua a tarefa e responda com 204 e um corpo vazio.
  • Se a tarefa não existir, ainda assim responda com 404.

Pressione Run e, em seguida, na aba Shell: from django.test import Client; print(Client().delete("/api/tasks/1/").status_code) exibe 204.

Experimente você mesmo

import json

from django.http import JsonResponse
from django.shortcuts import render
from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_GET, require_http_methods

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()})


@require_GET
def stats(request):
    data = {
        "total": Task.objects.count(),
        "done": Task.objects.filter(done=True).count(),
    }
    return JsonResponse(data)


@csrf_exempt
@require_http_methods(["GET", "POST"])
def task_list(request):
    if request.method == "POST":
        try:
            data = json.loads(request.body)
        except json.JSONDecodeError:
            return JsonResponse({"error": "The body is not valid JSON."}, status=400)
        errors = {}
        title = data.get("title", "").strip()
        if not title:
            errors["title"] = "This field is required."
        if errors:
            return JsonResponse({"errors": errors}, status=400)
        task = Task.objects.create(
            title=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)


@csrf_exempt
@require_http_methods(["GET", "PATCH"])
def task_detail(request, pk):
    task = Task.objects.filter(pk=pk).first()
    if task is None:
        return JsonResponse({"error": "Task not found"}, status=404)
    if request.method == "PATCH":
        data = json.loads(request.body)
        if "title" in data:
            task.title = data["title"]
        if "done" in data:
            task.done = data["done"]
        task.save()
    return JsonResponse(task_to_dict(task))

Todas as lições de APIs JSON

Pratique por conta própria: Playground de Django