Verwenden der GraphiQL-IDE graphiql-ide

Eine Implementierung der standardmäßigen GraphQL-IDE zur Verwendung mit der GraphQL-API von Adobe Experience Manager (AEM) ist verfügbar.

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

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

Sie können GraphiQL auf Ihrem System verwenden, damit Abfragen von Ihrer Client-Anwendung über GET-Anfragen durchgeführt werden können, und um Abfragen zu veröffentlichen. Zur Verwendung in der Produktion müssen 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 selecting-endpoint

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 creating-new-query

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

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

Verwenden Sie Speichern unter, um Ihre neue Abfrage beizubehalten.

Aktualisieren einer persistenten Abfrage updating-persisted-query

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

Die Abfrage wird im Editor-Panel 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 running-queries

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

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

Abfragevariablen query-variables

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

Zum Beispiel:

Veröffentlichen persistenter Abfragen publishing-persisted-queries

Wenn Sie Ihre persistierte Abfrage aus der Liste (linker Bereich) ausgewählt haben, können Sie die Aktionen Veröffentlichen und Veröffentlichung aufheben verwenden. Dadurch werden die Abfragen in Ihrer Publishing-Umgebung (z. B. dev-publish) aktiviert, damit Ihre Anwendungen beim Testen leicht darauf zugreifen können.

Kopieren der URL, um direkt auf die Abfrage zuzugreifen copy-url

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:

Zum 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:

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

Löschen persistenter Abfragen deleting-persisted-queries

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 installing-persisted-query-production

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 keyboard-shortcuts

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