PATCH ile Değişiklik Yapma
Coddy'nin Django Journey'sinin JSON API'leri bölümünün bir parçası. Ders 9 / 19.
Bir program, görevin URL'sine yalnızca {"done": true} göndererek görevi tamamlandı olarak işaretler. Bu URL, görevin kendisini, yani bir kaynağı temsil eder; yöntem ise kaynak üzerinde ne yapılacağını belirtir: GET kaynağı okur, PATCH bir kısmını değiştirir. Eşdeğer yöntem olan PUT ise kaynağın tamamını değiştirir.
Dolayısıyla PATCH görünümü yalnızca gövdedeki alanları değiştirir. Varsayılan değer kullanmak tuzağa düşürebilir. Bir kitapçı API'sinde:
book.title = data.get("title", "")Yalnızca {"available": false} gönderen bir program başlığı siler. Önce anahtarın gönderilip gönderilmediğini kontrol et: "title" in data yalnızca gönderildiyse True olur. Mevcut olan her alanı ayarla, bir kez kaydet ve değiştirilen nesneyi yanıt olarak gönder. Görünümün @csrf_exempt ve task_list örneğinde olduğu gibi require_http_methods içinde yeni yönteme ihtiyacı vardır.
Görev
OrtaProgramların bir görevi PATCH /api/tasks/<id>/ ile değiştirmesini sağlayın:
task_detail,GETvePATCHisteklerini kabul eder ve@csrf_exemptolarak işaretlenmiştir.- PATCH, yalnızca gövdede bulunmaları hâlinde
titlevedonedeğerlerini ayarlar, kaydeder ve görevle yanıt verir. - Görev bulunamazsa yine 404 yanıtı verilir.
Run'a basın, ardından Shell sekmesinde: from django.test import Client; print(Client().patch("/api/tasks/1/", {"done": True}, content_type="application/json").json())
Kendin dene
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'leri bölümündeki tüm dersler
Kendi başına pratik yap: Django playground