Articles
JSON:API hat viele Konzepte in der Spezifikation, die hier nicht alle dokumentiert sind. Allerdings müssen Nutzer des Moduls nicht alle Konzepte der Spezifikation vollständig verstehen, um produktiv mit dem Modul zu arbeiten. Wenn Sie tiefer einsteigen möchten, wie JSON:API-Dokumente aufgebaut sind, warum das Modul etwas auf eine bestimmte Weise macht oder einfach mehr über das Design des Moduls erfahren möchten, sollten Sie die Spezifikation auf jsonapi.org lesen.
Sammlungen sind Auflistungen von Ressourcen. In einer entkoppelten Website werden sie verwendet, um Dinge wie eine "Neue Inhalte"-Liste oder einen "Meine Inhalte"-Bereich auf der Client-Seite zu erstellen.
Wenn Sie jedoch eine ungefilterte Anfrage an einen Collection-Endpunkt wie /jsonapi/node/article stellen, erhalten Sie einfach alle Artikel, die Sie sehen dürfen.
TL;DR: Verwenden Sie einen Query-String wie ?include=field_comments.uid, um alle von field_comments referenzierten Entitäten und alle von uid auf diesen Entitäten referenzierten Entitäten einzuschließen!
JSON:API hilft Ihnen, HTTP-Anfragen zu reduzieren, indem Sie Beziehungs-Pfade angeben können, die Sie im Antwort-Dokument enthalten möchten. Wie?
Paginierung kann ein trügerisch komplexes Thema sein. Es ist leicht, in Fallen zu tappen und Best Practices nicht zu befolgen. Diese Seite wird Ihnen helfen, die Paginierung „richtig“ zu machen. Wenn Sie diese Seite lesen und verstehen, wird Ihr Client robuster und zukunftssicherer sein und Ihnen das Leben langfristig erleichtern.
Wenn Sie nur eine Sache aus diesem Leitfaden mitnehmen, dann sollte es sein, dass Sie Ihre eigenen Paginierungs-URLs nicht selbst konstruieren sollten.
JSON:API ermöglicht es, mehrere Ressourcen in einer einzigen Anfrage abzurufen. Diese Routen werden als „Sammlungsrouten“ bezeichnet. Eine Sammlung von Ressourcen kann durch das Senden einer GET-Anfrage an die Basisressourcen-Route abgerufen werden, z.B. GET /jsonapi/node/article – dabei wird keine UUID angegeben. Standardmäßig werden so alle Ressourcen des angegebenen Typs zurückgegeben.
Das JSON:API-Modul stellt Entitätsrevisionen als Ressourcenversionen zur Verfügung, inspiriert von RFC5829: Link Relation Types for Simple Version Navigation between Web Resources.
Aktuelle Einschränkungen:
JSON:API unterstützt sehr einfache mehrsprachige Funktionalität. Fortgeschrittene Anwendungsfälle werden nicht unterstützt.
Dieser Abschnitt enthält Beispiele und Informationen pro Anfragetyp: GET, POST, PATCH und DELETE
Über die Beispiele
Alle Beispiele sind funktionierende Beispiele, die du entweder im Browser oder in einem JSON-Client (z. B. Postman) ausprobieren kannst. Du benötigst eine Standard-Drupal-Installation, einige Artikel-Nodes und das aktivierte JSON:API-Modul.