Erstellen einer API-Anfrage – Headless-Einrichtung accessing-delivering-content-fragments

Gehen Sie zu Tools, Allgemein und wählen Sie GraphQL aus.

Wählen Sie Erstellen aus.

Das Dialogfeld Neuen GraphQL-Endpunkt erstellen wird geöffnet. Hier können Sie Folgendes angeben:

• Name: Name des Endpunkts; Sie können einen beliebigen Text eingeben.
• GraphQL-Schema verwenden, das bereitgestellt wurde von: Verwenden Sie die Dropdown-Liste, um die gewünschte Konfiguration auszuwählen.

Bestätigen Sie mit Erstellen.

In der Konsole wird nun ein Pfad basierend auf der zuvor erstellten Konfiguration angezeigt. Dieser Pfad wird zum Ausführen von GraphQL-Abfragen verwendet.

/content/cq:graphql/<configuration-name>/endpoint

Melden Sie sich bei AEM as a Cloud Service an und rufen Sie die GraphiQL-Oberfläche auf:

Sie können auf den Abfrage-Editor wie folgt zugreifen:

• Tools > Allgemein > GraphQL-Abfrage-Editor
• direkt, zum Beispiel: http://localhost:4502/aem/graphiql.html

Die GraphiQL-IDE ist ein In-Browser-Abfrage-Editor für GraphQL. Sie können damit Abfragen zum Abrufen von Inhaltsfragmenten erstellen, um diese als JSON-Datei headless bereitzustellen.

• In der Dropdown-Liste oben rechts können Sie den Endpunkt auswählen.
• In einem Bereich ganz links werden die persistenten Abfragen aufgelistet (sofern verfügbar)
• Im mittleren linken Bereich können Sie Ihre Abfrage erstellen.
• Im mittleren rechten Bereich werden die Ergebnisse angezeigt.
• Der Abfrage-Editor bietet Code-Vervollständigung und Hotkeys, um die Abfrage einfach auszuführen.

Angenommen, das von uns erstellte Modell person wurde mit den Feldern firstName, lastName und position aufgerufen. Wir können dann eine einfache Abfrage erstellen, um den Inhalt unseres Inhaltsfragments abzurufen.

query
{
  personList {
    items {
      _path
      firstName
      lastName
      position
    }
  }
}

Geben Sie die Abfrage in das linke Bedienfeld ein.

Klicken Sie auf die Schaltfläche Abfrage ausführen oder verwenden Sie den Ctrl-Enter-Hotkey. Die Ergebnisse werden als JSON im rechten Bedienfeld angezeigt.

Klicken Sie oben rechts auf der Seite auf den Link Dokumente, um die kontextbezogene Dokumentation anzuzeigen, damit Sie Abfragen erstellen können, die sich an Ihre eigenen Modelle anpassen.