שינוי באמצעות PATCH

חלק מהיחידה ממשקי API של JSON במסלול ה-Django של Coddy. שיעור 9 מתוך 19.

תוכנית מסמנת משימה כהושלמה על ידי שליחת {"done": true} לכתובת ה-URL של המשימה, ולא שום דבר אחר. הכתובת הזאת מייצגת את המשימה עצמה, משאב, והשיטה מציינת מה לעשות איתו: GET קוראת אותו, PATCH משנה חלק ממנו. האחות שלה, PUT, מחליפה את המשאב כולו.

לכן תצוגת PATCH משנה רק את השדות שבגוף הבקשה. ערך ברירת מחדל הוא המלכודת. ב-API של חנות ספרים:

book.title = data.get("title", "")

תוכנית ששולחת רק {"available": false} מוחקת את הכותרת. בדקו קודם אם המפתח נשלח: "title" in data הוא True רק אז. הגדירו כל שדה שנשלח, שמרו פעם אחת, והשיבו עם האובייקט ששונה. התצוגה זקוקה ל-@csrf_exempt ולשיטה החדשה בתוך require_http_methods, כפי שיש ב-task_list.

אתגר

בינוני

אפשר לתוכניות לשנות משימה באמצעות PATCH /api/tasks/<id>/:

task_detail מקבלת GET ו־PATCH, והיא מסומנת ב־@csrf_exempt.
PATCH מגדירה את title ואת done רק אם הם מופיעים בגוף הבקשה, שומרת ומשיבה עם המשימה.
אם המשימה חסרה, עדיין מתקבלת תשובת 404.

לחצו על Run, ואז בכרטיסייה Shell: 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))