Projekt: Prioritäten

Teil des Abschnitts JSON-APIs der Django-Journey von Coddy. Lektion 15 von 19.

Jetzt kannst du selbst ein Feature hinzufügen. Jede Aufgabe hat eine priority: low, normal oder high. Die API sollte Programmen ermöglichen, eine Priorität abzufragen, und verhindern, dass jemand eine vierte erfindet.

Du hast bereits alle nötigen Teile: request.GET.get() für einen Filter, ein QuerySet, das du mehrmals filtern kannst, und das errors-Wörterbuch, das mit 400 antwortet.

Die zulässigen Werte sind im Modell definiert. Task.Priority ist eine TextChoices-Klasse, und Task.Priority.values ist die Liste ["low", "normal", "high"]. Wenn du dagegen prüfst, wird eine später zum Modell hinzugefügte Priorität ohne Änderung an der View akzeptiert.

Aufgabe

Mittel

Füge der API Prioritäten hinzu:

/api/tasks/?priority=high listet nur Aufgaben mit hoher Priorität auf und funktioniert auch mit ?done=: ?priority=high&done=false.
Ein POST mit einer anderen Priorität als low, normal oder high gibt 400 mit einem Fehler unter "priority" zurück und speichert nichts.
Ohne angegebene Priorität gilt weiterhin normal.

Klicke auf „Run“: In der Vorschau wird die eine Aufgabe mit hoher Priorität aufgelistet.

Probier es selbst

import json

from django.http import HttpResponse, JsonResponse
from django.shortcuts import get_object_or_404, render
from django.utils.decorators import method_decorator
from django.views import View
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")


def task_page(request):
    return render(request, "tasks/list.html", {"tasks": Task.objects.all()})


def task_row(request, pk):
    task = get_object_or_404(Task, pk=pk)
    return render(request, "tasks/list.html#task-row", {"task": task})


@require_GET
def stats(request):
    total = Task.objects.count()
    done = Task.objects.filter(done=True).count()
    data = {
        "total": total,
        "done": done,
        "open": total - done,
    }
    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)


def not_found():
    return JsonResponse({"error": "Task not found"}, status=404)


@method_decorator(csrf_exempt, name="dispatch")
class TaskDetail(View):
    def get(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        return JsonResponse(task_to_dict(task))

    def patch(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        data = json.loads(request.body)
        if "title" in data:
            task.title = data["title"]
        if "done" in data:
            task.done = data["done"]
        task.save()
        return JsonResponse(task_to_dict(task))

    def delete(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        task.delete()
        return HttpResponse(status=204)