التعديل باستخدام PATCH

جزء من قسم واجهات API بصيغة JSON في رحلة Django على Coddy. الدرس 9 من 19.

يُعلِم البرنامج بأن المهمة أُنجزت بإرسال {"done": true} إلى عنوان URL الخاص بالمهمة، ولا يرسل أي شيء آخر. يمثّل عنوان 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، استبدل @require_GET في task_detail بمُزيِّن يسمح بـ GET وPATCH، وأضف @csrf_exempt فوقه.
عند إجراء PATCH، اقرأ جسم JSON، واضبط title وdone فقط إذا كانا موجودين فيه، ثم احفظ المهمة وأعِدها.

شغّل السطر أدناه في علامة تبويب الصَدَفة: سيطبع المهمة التي تحتوي على '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))