Eine Aufgabe anhand der ID

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

Ein Programm, das die Liste gelesen hat, möchte nun eine einzelne Aufgabe unter ihrer eigenen URL abrufen: /api/tasks/1/. Die Route übernimmt die ID mit <int:pk>, wie es auch deine Detailseiten getan haben, und die Hilfsfunktion task_to_dict(task) des Startercodes wandelt eine Aufgabe in ein Wörterbuch um.

Neu ist der Fall einer fehlenden Aufgabe. get_object_or_404 antwortet mit Djangos HTML-404-Seite, die ein Programm nicht lesen kann. Eine API gibt Fehler ebenfalls als JSON zurück, zusammen mit dem passenden HTTP-Statuscode, der angibt, wie eine Anfrage ausgegangen ist: 200 OK, 403 Forbidden, 404 Not Found. JsonResponse übernimmt ihn als status:

return JsonResponse({"error": "Staff only"}, status=403)

Um zwischen dem Fehler und der Aufgabe zu wählen, rufst du den Datensatz ab, ohne eine Ausnahme auszulösen: filter(pk=...).first() gibt den Datensatz zurück oder None, wenn keiner vorhanden ist.

Aufgabe

Einfach

Füge einen Endpunkt für eine einzelne Aufgabe hinzu:

Eine View task_detail(request, pk), die task_to_dict(task) als JSON zurückgibt.
Bei einer fehlenden ID: {"error": "Task not found"} mit Status 404.
Die Route "api/tasks/<int:pk>/" mit dem Namen task_detail.

Klicke auf Run und öffne dann /api/tasks/1/ und /api/tasks/99/.

Probier es selbst

from django.http import JsonResponse
from django.shortcuts import render

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()})


def stats(request):
    data = {
        "total": Task.objects.count(),
        "done": Task.objects.filter(done=True).count(),
    }
    return JsonResponse(data)


def task_list(request):
    tasks = Task.objects.values("id", "title", "done", "priority")
    return JsonResponse(list(tasks), safe=False)