Eine Implementierung der standardmäßigen GraphQL-IDE ist für die Verwendung mit der GraphQL-API von Adobe Experience Manager (AEM) as a Cloud Service verfügbar.
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. Sollten Sie ein solches Paket installiert haben, kann es jetzt entfernt werden.
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:
dev-publish
)Sie können auf den Abfrage-Editor wie folgt zugreifen:
http://localhost:4502/aem/graphiql.html
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.
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.
Sie können Ihre neue Abfrage im Editor eingeben, der sich im Bereich links in der Mitte, direkt unter dem GraphiQL-Logo befindet.
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:
GraphQL-Abfragen beginnen normalerweise mit dem Zeichen {
.
Zeilen, die mit einem #
beginnen, werden ignoriert.
Verwenden Sie Speichern unter, um Ihre neue Abfrage beizubehalten.
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.
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:
Control-Enter
verwenden.Mit der GraphiQL-IDE können Sie auch Ihre Abfragevariablen verwalten.
Beispiel:
Persistente Abfragen werden empfohlen, da sie in den Dispatcher- und CDN-Ebenen zwischengespeichert werden können, was letztendlich die Leistung der anfordernden Client-Anwendung verbessert. Standardmäßig macht AEM den Cache des Content Delivery Network (CDN) basierend auf einer Standard-TTL (Time To Live) ungültig.
Weitere Informationen finden Sie unter Zwischenspeichern persistierter Abfragen.
Benutzerdefinierte Neuschreibungsregeln für den Dispatcher können die Standardeinstellungen für AEM Publish überschreiben.
Falls Sie TTL-basierte Cache-Steuerungs-Header vom Dispatcher senden, die auf einem Muster für Standortübereinstimmungen basieren, sollten Sie gegebenenfalls /graphql/execute.json/*
aus den Übereinstimmungen ausschließen.
Mit GraphQL können Sie die HTTP-Cache-Header konfigurieren, um diese Parameter für einzelne persistente Abfragen festzulegen.
Die Option Headers kann über die drei vertikalen Punkte rechts neben dem Namen der persistenten Abfrage (ganz linkes Bedienfeld) aufgerufen werden:
Wenn Sie dies auswählen, öffnet sich der Dialog Cache-Konfiguration:
Wählen Sie den entsprechenden Parameter aus und passen Sie dann den Wert nach Bedarf an:
Wählen Sie Speichern, um die Änderungen beizubehalten.
Nachdem Sie Ihre persistente 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.
Für den Cache Time To Live
der persistenten Abfrage {"cache-control":"parameter":value} ist der Standardwert von 2 Stunden (7.200 Sekunden) definiert.
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:
Die Option URL kopieren ist über die drei vertikalen Punkte rechts neben dem Namen der persistenten Abfrage zugänglich (Bereich ganz links):
Die Option Löschen ist auch über die drei vertikalen Punkte rechts neben dem Namen der persistenten Abfrage (Bereich ganz links) zugänglich.
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.
Es gibt eine Auswahl von Tastaturbefehlen, die direkten Zugriff auf Aktionssymbole in der IDE bieten:
Shift-Control-P
Shift-Control-M
Control-Enter
Control-Space
Auf manchen Tastaturen ist die Taste Control
mit Ctrl
beschriftet.