Menu
CoddyTech

Изменение с помощью PATCH

Часть раздела JSON API путешествия по Django на Coddy. Урок 9 из 19.

Программа отмечает задачу как выполненную, отправляя {"done": true} на URL этой задачи, и ничего больше. Этот URL указывает на саму задачу — ресурс, а метод определяет, что с ним делать: GET считывает его, PATCH изменяет его часть. Родственный ему метод PUT заменяет ресурс целиком.

Поэтому представление для PATCH изменяет только поля, указанные в теле запроса. Значение по умолчанию здесь может стать ловушкой. В API книжного магазина:

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

Программа, которая отправляет только {"available": false}, стирает название. Сначала проверьте, был ли отправлен ключ: "title" in data имеет значение True только в этом случае. Задайте значение для каждого присутствующего поля, сохраните один раз и верните изменённый объект. Представлению нужны @csrf_exempt и новый метод в require_http_methods, как в task_list.

challenge icon

Задание

Средне

Позволь программам изменять задачу с помощью 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))

Все уроки раздела JSON API

Потренируйтесь самостоятельно: Песочница Django