Schnellstartanleitung für Headless: Abrufen und Bereitstellen von Inhaltsfragmenten

Letzte Aktualisierung: 2023-08-15
  • Themen:
  • Developing
    Weitere Informationen zu diesem Thema
  • Erstellt für:
  • Developer

Erfahren Sie, wie Sie die AEM Assets-REST-API zum Verwalten von Inhaltsfragmenten und die GraphQL-API für die Headless-Bereitstellung von Inhalten der Inhaltsfragmente verwenden.

Was sind GraphQL- und Assets-REST-APIs?

Nachdem Sie einige Inhaltsfragmente erstellt haben, können Sie die APIs von AEM verwenden, um sie headless bereitzustellen.

Der Rest dieses Handbuchs konzentriert sich auf die Bereitstellung von GraphQL-Zugriff und Inhaltsfragmenten.

Bereitstellen eines Inhaltsfragments mit GraphQL

Informationsarchitekten müssen Abfragen für ihre Kanalendpunkte entwerfen, um Inhalte bereitzustellen. Diese Abfragen dürfen pro Endpunkt pro Modell nur einmal berücksichtigt werden. Für die Zwecke dieses Erste-Schritte-Handbuchs müssen Sie nur einen erstellen.

  1. Melden Sie sich bei AEM an und rufen Sie die GraphiQL-Oberfläche auf:

    • Beispiel: http://<host>:<port>/aem/graphiql.html.
  2. GraphiQL ist ein In-Browser-Abfrage-Editor für GraphQL. Sie können sie verwenden, um Abfragen zum Abrufen von Inhaltsfragmenten zu erstellen, um sie als JSON-Datei bereitzustellen.

    • Im linken Bereich können Sie Ihre Abfrage erstellen.

    • Im rechten Bedienfeld werden die Ergebnisse angezeigt.

    • Der Abfrage-Editor bietet Code-Vervollständigung und Hotkeys, um die Abfrage einfach auszuführen.

      GraphiQL-Editor

  3. Angenommen, das von Ihnen erstellte Modell wurde person mit Feldern firstName, lastName, und positionkönnen Sie eine einfache Abfrage erstellen, um den Inhalt des Inhaltsfragments abzurufen.

    query
    {
      personList {
        items {
          _path
          firstName
          lastName
          position
        }
      }
    }
    
  4. Geben Sie die Abfrage in das linke Bedienfeld ein.

  5. Klicken Sie auf das Symbol Abfrage ausführen (Pfeil nach rechts) oder verwenden Sie das Tastaturkürzel Ctrl-Enter. Die Ergebnisse werden als JSON im rechten Bedienfeld angezeigt.
    GraphiQL-Ergebnisse

  6. Klicken Sie auf:

    • Dokumente oben rechts auf der Seite eine kontextbezogene Dokumentation anzeigen, die Sie beim Erstellen Ihrer Abfragen unterstützt, die sich an Ihre eigenen Modelle anpassen.

    • Verlauf in der oberen Symbolleiste, um frühere Abfragen anzuzeigen.

    • Wählen Sie Speichern unter und Speichern, um Ihre Abfragen zu speichern. Danach können Sie sie im Bedienfeld Persistierte Abfragen auflisten, abrufen und veröffentlichen.

      GraphiQL-Dokumentation

GraphQL ermöglicht strukturierte Abfragen, die nicht nur auf bestimmte Datensätze oder einzelne Datenobjekte abzielen, sondern auch bestimmte Elemente der Objekte, verschachtelte Ergebnisse, Unterstützung für Abfragevariablen und vieles mehr bereitstellen können.

GraphQL kann iterative API-Anfragen und Überlieferungen vermeiden. Stattdessen ermöglicht sie die Massenbereitstellung genau der Elemente, die für die Darstellung als Antwort auf eine einzelne API-Abfrage benötigt werden. Das resultierende JSON kann verwendet werden, um Daten in anderen Sites oder Mobile Apps bereitzustellen.

Nächste Schritte

Das war´s! Sie haben nun ein grundlegendes Verständnis für das Headless-Content-Management in AEM. Es gibt viele weitere Ressourcen, in denen Sie sich tiefer eintauchen können, um ein umfassendes Verständnis der verfügbaren Funktionen zu erhalten.

Auf dieser Seite