使用 PATCH 修改
本课属于 Coddy Django 学习旅程的“JSON API”单元。第 9 课,共 19 课。
程序会向任务的 URL 发送 {"done": true},且不发送其他内容,以此将任务标记为已完成。这个 URL 指向一个任务,称为资源。方法说明要对它执行什么操作:GET 用于读取,PATCH 用于修改其中一部分。
因此,PATCH 视图只会修改请求正文中的字段。注意默认值。在书店 API 中:
book.title = data.get("title", "")如果程序只发送 {"available": false},书名就会被清空。先检查是否发送了这个键:只有在发送了该键时,"title" in data 才是 True。设置所有存在的字段,只保存一次,然后返回修改后的对象。这个视图需要 @csrf_exempt,并且要在 require_http_methods 中加入新方法,就像 task_list 一样。
挑战
中等让程序修改任务。
- 在
tasks/views.py中,把task_detail上的@require_GET替换为允许GET和PATCH的装饰器,并在它上方添加@csrf_exempt。 - 对于 PATCH 请求,读取 JSON 请求体,仅当其中包含
title和done时才设置它们,然后保存并返回任务。
在 Shell 标签页中运行下面这行代码:它会打印包含 'done': True 的任务。
from django.test import Client; print(Client().patch("/api/tasks/1/", {"done": True}, 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 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)
@require_GET
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 在线编辑器