删除任务

本课属于 Coddy Django 学习旅程的“JSON API”单元。第 10 课，共 19 课。

已完成的任务应该被删除，而不只是打上勾：DELETE /api/tasks/1/ 会删除任务 1，之后就没有内容需要发回了。

HTTP 为此提供了 204 No Content：请求成功，响应没有正文。JsonResponse 总会写入正文，即使是 {} 也一样。只设置状态码的普通 HttpResponse 不会发送其他内容：

def mark_read(request, pk):
    Notification.objects.filter(pk=pk).update(read=True)
    return HttpResponse(status=204)

先保留 404 检查，这样删除不存在的任务时仍会返回 404。

一个 URL，三种方法：GET 读取任务，PATCH 修改任务，DELETE 删除任务。每种资源对应一个 URL，并用方法表示动作，这就是人们所说的 REST API。

挑战

简单

让程序使用 DELETE /api/tasks/<id>/ 删除任务。在 tasks/views.py 中，允许 "DELETE" 用于 task_detail，然后删除任务，并返回状态码 204 和空响应正文。任务不存在时，仍返回 404。

在 Shell 选项卡中运行下面这行代码两次：它会先输出 204，然后输出 404，因为任务 1 已经不存在了。

from django.test import Client; print(Client().delete("/api/tasks/1/").status_code)

亲手试试

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