Verwenden der GraphiQL-IDE

Eine Implementierung der standardmäßigen GraphiQL-IDE ist für die Verwendung mit der GraphQL-API von Adobe Experience Manager (AEM) as a Cloud Service verfügbar.

HINWEIS

GraphiQL ist in allen Umgebungen von AEM enthalten (kann jedoch nur bei der Konfiguration Ihrer Endpunkte aufgerufen/angezeigt werden).

In früheren Versionen war ein Paket erforderlich, um die GraphiQL-IDE zu installieren. Wenn Sie diese installiert haben, kann sie jetzt entfernt werden.

HINWEIS

Sie müssen Ihre Endpunkte im Konfigurationsbrowser konfiguriert haben, bevor Sie die GraphiQL-IDE verwenden.

Das GraphiQL-Tool erlaubt es Ihnen, Ihre GraphQL-Abfragen zu testen und zu debuggen, indem es Ihnen folgendes ermöglicht:

  • Auswahl des Endpunkts, der der Sites-Konfiguration entspricht, die Sie für Ihre Abfragen verwenden möchten
  • direkte Eingabe neuer Abfragen
  • Erstellen und Zugreifen auf Persistente Abfragen
  • Ausführen von Abfragen mit sofortiger Anzeige der Ergebnisse
  • Verwalten von Abfragevariablen
  • Speichern und Verwalten von Persistenten Abfragen
  • Veröffentlichung oder Rückgängigmachen der Veröffentlichung, Beständige Abfragen (z. B. nach/von dev-publish)
  • Anzeige des Verlaufs der vorherigen Abfragen
  • Verwenden des Dokumentations-Explorers, um auf die Dokumentation zuzugreifen; hilft Ihnen zu lernen und zu verstehen, welche Methoden verfügbar sind.

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

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

GraphiQL-Oberfläche

Sie können GraphiQL in Ihrem System verwenden, damit Abfragen von Ihrer Clientanwendung mithilfe von GET-Anfragen sowie zur Veröffentlichung von Abfragen angefordert werden können. Zur Verwendung in der Produktion können Sie dann Ihre Abfragen in Ihre Produktionsumgebung verschieben. Zunächst an den Produktionsautor, um die neu erstellten Inhalte mit den Abfragen zu validieren, und schließlich an die Produktionsveröffentlichung für die Live-Nutzung.

Auswahl des Endpunkts

In einem ersten Schritt müssen Sie den Endpunkt auswählen, den Sie für die Abfragen verwenden möchten. Der Endpunkt ist für die Sites-Konfiguration geeignet, die Sie für Ihre Abfragen verwenden möchten.

Diese ist in der Dropdown-Liste oben rechts verfügbar.

Erstellen und Beibehalten einer neuen Abfrage

Sie können Ihre neue Abfrage im Editor eingeben, der sich im Bereich links in der Mitte, direkt unter dem GraphiQL-Logo befindet.

HINWEIS

Wenn Sie bereits eine gespeicherte Abfrage ausgewählt haben, die im Editorbereich angezeigt wird, wählen Sie + (neben Persistente Abfragen), um den Editor für Ihre neue Abfrage zu leeren.

Fangen Sie einfach an zu tippen, im Editor ist auch folgendes möglich:

  • Verwenden von Mouse-over, um zusätzliche Informationen über Elemente anzuzeigen
  • bietet Funktionen wie Syntax-Hervorhebung, Autovervollständigung, Auto-Vorschlag
HINWEIS

GraphQL-Abfragen beginnen normalerweise mit dem Zeichen {.

Zeilen, die mit einem # beginnen, werden ignoriert.

Verwenden Sie Speichern unter, um Ihre neue Abfrage beizubehalten.

Aktualisieren einer persistenten Abfrage

Wählen Sie die Abfrage, die Sie aktualisieren möchten, aus der Liste im Bereich Persistente Abfragen (ganz links).

Die Abfrage wird im Editor-Bereich angezeigt. Nehmen Sie die gewünschten Änderungen vor, und verwenden Sie dann Speichern, um die Aktualisierungen in der persistenten Abfrage zu speichern.

Ausführen von Abfragen

Sie können eine neue Abfrage sofort ausführen oder eine persistente Abfrage laden und ausführen. Um eine persistente Abfrage zu laden, wählen Sie sie aus der Liste aus. Die Abfrage wird im Editor-Bereich angezeigt.

In beiden Fällen ist die Abfrage, die im Editor-Bereich angezeigt wird, die Abfrage, die ausgeführt wird, wenn Sie entweder:

  • auf das Symbol Abfrage ausführen klicken/tippen oder
  • die Tastaturkombination Control-Enter verwenden.

Abfragevariablen

Mit der GraphiQL-IDE können Sie auch Ihre Abfragevariablen verwalten.

Beispiel:

GraphQL-Variablen

Verwalten des Cache für die gespeicherten Abfragen

Beständige Abfragen werden empfohlen, da sie auf den Dispatcher- und CDN-Ebenen zwischengespeichert werden können, was letztendlich die Leistung der anfragenden Client-Anwendung verbessert. Standardmäßig werden AEM den CDN-Cache (Content Delivery Network) basierend auf einer standardmäßigen Time to Live (TTL) ungültig.

Mit GraphQL können Sie die HTTP-Cache-Header konfigurieren, um diese Parameter für Ihre einzelne persistente Abfrage zu steuern.

  1. Die Kopfzeilen -Option können Sie über die drei vertikalen Punkte rechts neben dem beibehaltenen Abfragenamen (ganz links) aufrufen:

    Persistente Abfrage-HTTP-Cache-Header

  2. Wenn Sie diese Option auswählen, wird das Cachekonfiguration dialog:

    Einstellungen für beständige Abfrage-HTTP-Cache-Header

  3. Wählen Sie den entsprechenden Parameter aus und passen Sie dann den Wert nach Bedarf an:

    • cache-control - max-age
      Caches können diesen Inhalt für eine bestimmte Anzahl von Sekunden speichern. Normalerweise ist dies die TTL des Browsers (Time To Live).
    • Ersatzsteuerung - s-maxage
      Entspricht maximalem Alter, gilt jedoch speziell für Proxy-Caches.
    • Ersatzsteuerung - stale-while-revalidate
      Caches können eine zwischengespeicherte Antwort auch dann weiter bereitstellen, wenn sie bis zu der festgelegten Anzahl von Sekunden veraltet ist.
    • Ersatzsteuerung - stale-if-error
      Caches können im Falle eines Ursprungs- oder Ursprungsfehlers bis zu einer festgelegten Anzahl von Sekunden weiterhin eine zwischengespeicherte Antwort bereitstellen.
  4. Auswählen Speichern um die Änderungen beizubehalten.

Persistente Abfragen veröffentlichen

Sobald Sie Ihre persistente Abfrage aus der Liste (linker Bereich) ausgewählt haben, können Sie die Aktionen Veröffentlichen und Veröffentlichung rückgängig machen verwenden. Dadurch werden sie in Ihrer Veröffentlichungsumgebung aktiviert (z. B. dev-publish) für den einfachen Zugriff Ihrer Anwendungen beim Testen.

HINWEIS

Die Definition des Caches Time To Live der persistenten Abfrage {"cache-control":"parameter":value} hat einen Standardwert von 2 Stunden (7200 Sekunden).

Kopieren der URL, um direkt auf die Abfrage zuzugreifen

Mit der Option URL kopieren können Sie eine Abfrage simulieren, indem Sie die URL kopieren, mit der Sie direkt auf die persistente Abfrage zugreifen und die Ergebnisse sehen. Diese kann dann zu Testzwecken verwendet werden, z. B. durch Zugriff in einem Browser:

Beispiel:

http://localhost:4502/graphql/execute.json/global/article-list-01

Wenn Sie diese URL in einem Browser verwenden, können Sie die Ergebnisse bestätigen:

GraphiQL – URL kopieren

Die Option URL kopieren ist über die drei vertikalen Punkte rechts neben dem Namen der persistenten Abfrage zugänglich (Bereich ganz links):

GraphiQL – URL kopieren

Löschen persistenter Abfragen

Die Option Löschen ist auch über die drei vertikalen Punkte rechts neben dem Namen der persistenten Abfrage (Bereich ganz links) zugänglich.

Installieren der persistenten Abfrage in der Produktion

Nachdem Sie Ihre persistente Abfrage mit GraphiQL entwickelt und getestet haben, ist das letzte Ziel, sie in Ihre Produktionsumgebung zu übertragen, damit sie von Ihren Anwendungen verwendet werden kann.

Tastaturbefehle

Es gibt eine Auswahl von Tastaturbefehlen, die direkten Zugriff auf Aktionssymbole in der IDE bieten:

  • Abfrage schön machen: Shift-Control-P
  • Abfrage fusionieren: Shift-Control-M
  • Abfrage ausführen: Control-Enter
  • Automatisch vervollständigen: Control-Space
HINWEIS

Auf manchen Tastaturen ist die Taste Control mit Ctrl beschriftet.

Auf dieser Seite