Headless CMS. Wie können Daten mithilfe von REST API und JSON API Modulen offengelegt werden?

Headless CMS, ein Content-Management-System, das direkt nicht mit der Frontend-Schicht verbunden ist, ermöglicht die flexible Datenbereitstellung für verschiedene Anwendungen. Dieses Konzept wird besonders wichtig für Teams, die moderne Anwendungen mit einer separaten Frontend-Schicht in Systemen wie Drupal erstellen möchten. In diesem Blogbeitrag werde ich Ihnen Schritt für Schritt den Prozess der Bereitstellung von Drupal-Daten mithilfe der REST-API und der JSON-API erklären. Sie sehen, wie Sie Ansichten anpassen, Inhalte erzeugen und Einstellungen verwalten, um eine nahtlose Interoperabilität mit Frontend-Frameworks sicherzustellen. Ich empfehle Ihnen, den Artikel zu lesen oder sich das Video der „Nowoczesny Drupal“-Reihe anzuschauen (das Video ist auf Polnisch).

Erforderliche Module und Werkzeuge für die Arbeit mit Headless CMS

Wir installieren Drupal. Zunächst benötigen wir zwei Schlüsselmodule:

1. RESTful Web Services - aktiviert grundlegende API-Funktionen in Drupal und aktiviert automatisch das Serialisierungsmodul.
2. JSON API (zusammen mit JSON API Extras) - die Module bieten umfassende Funktionen zur Bereitstellung von Daten im JSON-Format. Darüber hinaus ermöglicht JSON API Extras die Anpassung von Pfaden und Endpoint-Einstellungen, was für eine reibungslose Integration entscheidend ist.

Jedes dieser Module ist in Drupal 10 verfügbar.

Erstellen von Ansichten für API-Daten

Um mit der Bereitstellung von Artikeldaten im JSON-Format zu beginnen, müssen wir Drupal-Ansichten konfigurieren. Dieser Prozess umfasst mehrere Schritte:

1. Erstellen einer neuen Ansicht - nach der Installation der erforderlichen Module gehen wir in den Abschnitt „Ansichten“ des Administrationspanels. Wir erstellen eine Ansicht und wählen die Art der Daten, die wir anzeigen möchten (zum Beispiel eine Liste von Artikeln).

2. JSON-Formatierung - wir konfigurieren die Ansicht so, dass die Daten im JSON-Format verfügbar sind und definieren den Zugriffspfad, wie zum Beispiel API/V1/articles. Mit der Pfadversionierung können wir APIs entwickeln, ohne in bereits laufende Versionen einzugreifen.

3. Filtern und Feldauswahl - um nur die benötigten Daten anzuzeigen, fügen wir Filter hinzu, die die Ansicht auf bestimmte Inhaltstypen, wie Artikel, beschränken. Wir wählen auch spezifische Felder (z. B. Titel, Autor, Erstellungsdatum) aus, die in der API geteilt werden sollen.

Chrome zeigt eine klare JSON-Struktur, die UID und NID für jeden Knoten enthält. Das JSON zeigt die vollständige Liste der im System verfügbaren Elemente und bietet einen schnellen Überblick über die gesammelten Daten.

Anpassen des JSON-Formats

In Drupal können wir anpassen, wie JSON-Daten angezeigt werden, sodass sie klar und leicht interpretierbar sind:

• Entfernen unnötiger Felder - Wir beschränken JSON-Felder auf diejenigen, die relevant sind, und eliminieren unnötige Daten aus Drupal, wie timestamp oder Revisionsinformationen.
• Ändern von Feld-Aliassen - Für mehr Klarheit ändern wir die Feldnamen in freundlichere, z. B. verwenden wir article_id anstatt nid.
• Bereinigen von HTML-Tags - der „HTML entfernen“-Befehl ermöglicht es uns, HTML-Tags aus Textfeldern zu entfernen, was ihre Darstellung vereinfacht.

Verwendung von JSON API und JSON API Extras in Headless CMS

JSON API ist ein erweitertes Tool in Drupal, das es uns ermöglicht, CRUD (Create, Read, Update, Delete) Operationen innerhalb der API zu handhaben. JSON API Extras bietet zusätzliche Kontrolle über Pfade und Datenstruktur.

1. Konfigurieren von CRUD - in den JSON API-Einstellungen geben wir an, welche Operationen (Create, Read, Update, Delete) verfügbar sind. Dies ermöglicht uns zum Beispiel, Inhalte direkt über die API hinzuzufügen oder zu bearbeiten. Wir richten ein volles CRUD ein.

2. Personalisierung von Pfaden und Feldern mit JSON API Extras - das JSON API Extras-Modul ermöglicht es uns, Felder umzubenennen. Wir erstellen beispielsweise einen personalisierten API/V2/articles Pfad in JSON API Extras.

3. Erstellen von Filterungen und Aliasen - JSON API Extras ermöglicht es auch, die JSON-Struktur anzupassen, unnötige Felder zu eliminieren und klare Namen zu vergeben, was die Lesbarkeit der Daten erheblich verbessert. Mithilfe dieser Funktion ändern wir beispielsweise das title zum article.

Erweiterte Konfiguration mit JSON API Extras

JSON API Extras bietet erweiterte Optionen zur Anpassung von JSON-Pfaden und Datenstruktur, indem alternative Pfade für jede API-Version erstellt werden können. Als Beispiel geben wir dem Pfad ein API/V2/contact/feedback Format, das hilft, die Datenstruktur organisiert zu halten und umfangreiche Filter- und Bearbeitungsoptionen zu ermöglichen.

Hochladen von Daten zu Drupal

Mit der JSON API ist es möglich, Daten aus externen Anwendungen über das Kontaktformular an Drupal zu senden.

Kontaktformulare ist ein nützliches Werkzeug zur Datensammlung von Nutzern, wie Feedback oder Anfragen. In Kombination mit dem Contact Form Storage-Modul ermöglichen uns Formulare, eingereichte Daten innerhalb von Drupal zu speichern, um sie einfach anzusehen und zu verwalten. Dadurch wird Folgendes ermöglicht:

• Anpassung von Pfaden und Feldern - Mit JSON API Extras geben wir klar benannte Pfade und Felder an.
• Testen vor der Bereitstellung - Tests in Postman ermöglichen es uns, sicherzustellen, dass Daten korrekt gesendet und wie beabsichtigt verarbeitet werden.

Testen von Endpunkten mit Postman

Wir können die bereitgestellten API-Daten mit dem Postman-Tool testen, das es uns ermöglicht, schnell und einfach verschiedene HTTP-Methoden und JSON-Strukturen zu testen. Damit können wir zum Beispiel:

• Datenabruf überprüfen - testen, ob die Daten korrekt angezeigt werden und der Endpunkt korrekte Informationen zurückgibt.
• Hinzufügen und Aktualisieren von Daten simulieren—Die JSON API ermöglicht es uns, neue Einträge hinzuzufügen oder zu bearbeiten, und Tests in Postman ermöglichen es uns, genau zu sehen, wie Daten übertragen und empfangen werden.

Datenbereitstellung von Headless CMS - Zusammenfassung

Ein Headless CMS wie Drupal ist eine großartige Lösung für moderne Anwendungen, die flexible und einfache Datenbereitstellung mit RESTful Web Services und JSON API ermöglichen. Mit der JSON API-Konfiguration und JSON API Extras haben Sie eine Vielzahl anpassbarer Pfade und Datenstrukturen, die es Ihnen ermöglichen, skalierbare Lösungen zu schaffen und mit jedem Framework zu arbeiten.

Wenn Sie jedoch Herausforderungen bei komplexeren Konfigurationen haben oder Unterstützung bei der Bereitstellung von Daten in anderen Formaten benötigen, sind unsere Drupal-Agentur-Experten bereit, Ihnen zu helfen.