Best Practices für das Setup und die Verwendung von AEM GraphQL mit Inhaltsfragmenten best-practices-setup-use-aem-graphql-content-fragments

Diese Richtlinien fassen die empfohlenen Best Practices für das Setup, die Konfiguration und Verwendung von AEM mit GraphQL und Inhaltsfragmenten zusammen.

Erste Schritte getting-started

Machen Sie sich mit dem Thema vertraut:

Setup setup

Um AEM GraphQL für die Verwendung mit Inhaltsfragmenten und Apps sicher einzurichten, müssen Sie verschiedene Komponenten konfigurieren.

Erstellung von GraphQL-Endpunkten (einschließlich Sicherheit) graphql-endpoint-creation

Der Endpunkt ist der Pfad, der für den Zugriff auf GraphQL für AEM verwendet wird. Diese Endpunkte müssen erstellt und veröffentlicht werden, damit sie sicher aufgerufen werden können.

Details details-graphql-endpoint-creation

Verwalten von GraphQL-Endpunkten in AEM

Umgebungen environments-graphql-endpoint-creation

Endpunkte müssen konfiguriert werden in:

Für:

AEM Dispatcher-Caching dispatcher-caching

Das Caching persistierter Abfragen ist im Dispatcher standardmäßig nicht aktiviert. Eine Standardaktivierung ist nicht möglich, da Kundinnen und Kunden, die CORS (Cross-Origin Resource Sharing) mit mehreren Ursprüngen verwenden, ihre Dispatcher-Konfiguration überprüfen und möglicherweise aktualisieren müssen.

Details details-dispatcher-caching

Persistierte GraphQL-Abfragen – Aktivieren der Caching-Funktion im Dispatcher

Umgebungen environments-dispatcher-caching

Der Dispatcher wird normalerweise für Folgendes konfiguriert:

CORS-Setup cors-setup

Um auf den GraphQL-Endpunkt zuzugreifen, muss eine CORS-Richtlinie konfiguriert und einem AEM-Projekt hinzugefügt werden, das in AEM über Cloud Manager bereitgestellt wird. Dazu wird eine entsprechende OSGi-CORS-Konfigurationsdatei für den/die gewünschten Endpunkt(e) hinzugefügt.

Details details-cors-setup

Konfiguration der herkunftsübergreifenden Ressourcennutzung (Cross-Origin Resource Sharing, CORS)

Umgebungen environments-cors-setup

CORS wird in der Regel für Folgendes konfiguriert:

Authentifizierung authentication

Ein primäres Anwendungsbeispiel für die GraphQL-API von Adobe Experience Manager as a Cloud Service (AEM) für die Bereitstellung von Inhaltsfragmenten ist das Annehmen von Remote-Abfragen von Drittanbieter-Programmen oder -Services. Diese Remote-Abfragen erfordern möglicherweise einen authentifizierten API-Zugriff, um die Bereitstellung von Headless-Inhalten zu sichern.

Details details-authentication

Authentifizierung für AEM-GraphQL-Remote-Abfragen in Inhaltsfragmenten

Umgebungen environments-authentication

Die Authentifizierung ist normalerweise für Folgendes konfiguriert:

Für:

Berechtigungen permissions

Bei einer Headless-Implementierung gibt es mehrere Bereiche von Sicherheit und Berechtigungen, die berücksichtigt werden sollten. Berechtigungen und Rollen können je nach AEM-Umgebung, Autor oder Veröffentlichung, umfassend berücksichtigt werden. Jede Umgebung enthält unterschiedliche Rollen mit unterschiedlichen Anforderungen.

Details details-permissions

Überlegungen zu Berechtigungen für Headless-Inhalte

Umgebungen environments-permissions

Berechtigungen werden normalerweise für Folgendes konfiguriert:

Für:

Verwenden eines Content Delivery Network (CDN) cdn

GraphQL-Abfragen und ihre JSON-Antworten können im Cache gespeichert werden, wenn sie bei Verwendung eines CDN als GET-Anfragen anvisiert werden. Im Gegensatz dazu können nicht zwischengespeicherte Anfragen sehr teuer (ressourcenintensiv) sein und nur langsam verarbeitet werden, was weitere nachteilige Auswirkungen auf die Ursprungsressourcen bedeuten kann.

Details details-cdn

CDN in AEM as a Cloud Service

Umgebungen environments-cdn

Ein CDN ist normalerweise für Folgendes konfiguriert:

Konfigurieren und Erstellen von Inhaltsfragmenten cconfigure-create-content-fragments

AEM GraphQL wird zum Abrufen von Informationen aus Ihren Inhaltsfragmenten verwendet. Diese müssen nicht nur konfiguriert werden, sondern es sind auch eine Struktur und ein Speicherort zu definieren, bevor Sie den Inhalt erstellen können.

Details details-content-fragments

Umgebungen eenvironments-content-fragments

Inhaltsfragmente werden in folgenden Umgebungen definiert, erstellt, getestet, veröffentlicht und abgerufen:

Für:

Verwenden von AEM GraphQL use-aem-graphql

Optimieren Ihrer GraphQL-Abfragen optimize-graphql-queries

Diese Richtlinien helfen Ihnen bei der Vermeidung von Leistungsproblemen bei Ihren GraphQL-Abfragen.

Details details-optimize-graphql-queries

Optimieren von GraphQL-Abfragen

Zugriff auf GraphQL über Ihre Apps access-graphql-from-your-apps

AEM Headless-CMS bietet Entwickelnden die Freiheit, außergewöhnliche Erlebnisse mithilfe von Sprachen, Frameworks und Tools zu erstellen und bereitzustellen, mit denen sie bereits vertraut sind.

Details details-your-apps

Umgebungen environments-your-apps

Apps werden in der Regel für Folgendes entwickelt, getestet und verwendet:

Für:

Zusätzliche Ressourcen

Weitere Informationen zu AEM GraphQL und Inhaltsfragmenten finden Sie unter: