Implementierung des Standards GraphiQL 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. Wenn Sie diese installiert haben, kann sie jetzt entfernt werden.
Sie müssen -Endpunkte konfiguriert haben im Konfigurationsbrowser vor der Verwendung der GraphiQL IDE.
Die GraphiQL Mit können Sie Ihre GraphQL-Abfragen testen und debuggen, indem Sie:
dev-publish
)Sie können auf den Abfrageeditor wie folgt zugreifen:
http://localhost:4502/aem/graphiql.html
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 zum Produktionsautor für die Validierung neu erstellter Inhalte mit den Abfragen und schließlich zur Produktionsveröffentlichung für den Live-Verbrauch.
Als ersten Schritt müssen Sie die Endpunkt die Sie für die Abfragen verwenden möchten. Der Endpunkt ist der Sites-Konfiguration angemessen, 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 in der Mitte links im Bedienfeld befindet, direkt unter dem GraphiQL-Logo.
Wenn Sie bereits eine persistente Abfrage ausgewählt und im Editor angezeigt haben, wählen Sie +
(neben Beständige Abfragen), um den Editor für Ihre neue Abfrage zu leeren.
Beginnen Sie mit der Eingabe des Editors auch:
GraphQL-Abfragen beginnen normalerweise mit einer {
Zeichen.
Zeilen, die mit einer #
werden ignoriert.
Verwendung Speichern unter , um Ihre neue Abfrage beizubehalten.
Wählen Sie die zu aktualisierende Abfrage aus der Liste im Beständige Abfragen Bedienfeld (ganz links).
Die Abfrage wird im Editor angezeigt. Nehmen Sie die erforderlichen Änderungen vor und verwenden Sie dann Speichern , um Ihre Aktualisierungen in die persistente Abfrage zu übertragen.
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 daraufhin im Editor angezeigt.
In beiden Fällen ist die im Editor angezeigte Abfrage die Abfrage, die ausgeführt wird, wenn Sie entweder:
Control-Enter
Mit der GraphiQL IDE können Sie auch Ihre Abfragevariablen.
Beispiel:
Nachdem Sie die beibehaltene Abfrage aus der Liste (linker Bereich) ausgewählt haben, können Sie die Veröffentlichen und Veröffentlichung rückgängig machen Aktionen. Dadurch werden sie in Ihrer Veröffentlichungsumgebung aktiviert (z. B. dev-publish
) für den einfachen Zugriff Ihrer Anwendungen beim Testen.
Die Definition des Cache der gespeicherten Abfrage Time To Live
{"cache-control":"parameter":value} hat einen Standardwert von 2 Stunden (7200 Sekunden).
AEM macht den CDN-Cache (Content Delivery Network) basierend auf einer standardmäßigen Time To Live (TTL) ungültig.
Dieser Wert wird auf Folgendes festgelegt:
AEM GraphQL-Abfragen, die mit der GraphiQL-Benutzeroberfläche persistiert wurden, verwenden bei der Ausführung die standardmäßige TTL. Wenn Sie die TTL für Ihre GraphLQ-Abfrage ändern möchten, muss die Abfrage stattdessen mit der API-Methode persistiert werden. Hierzu gehört das Posten der Abfrage an AEM mithilfe von CURL in Ihrer Befehlszeilenschnittstelle.
Beispiel:
curl -X PUT \
-H 'authorization: Basic YWRtaW46YWRtaW4=' \
-H "Content-Type: application/json" \
"http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
-d \
'{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'
Die cache-control
kann zum Zeitpunkt der Erstellung (PUT) oder später (z. B. über eine POST-Anfrage) festgelegt werden. Das Cache-Steuerelement ist beim Erstellen der persistenten Abfrage optional, da AEM den Standardwert angeben kann. Siehe Beibehalten einer GraphQL-Abfrage, zum Beispiel für die Beibehaltung einer Abfrage mit curl.
Die URL kopieren -Option können Sie eine Abfrage simulieren, indem Sie die URL kopieren, die zum direkten Zugriff auf die beibehaltene Abfrage verwendet wird, und die Ergebnisse anzeigen. Dies kann dann zum Testen verwendet werden. Beispielsweise durch Zugriff in einem Browser:
Beispiel:
http://localhost:4502/graphql/execute.json/global/article-list-01
Durch die Verwendung dieser URL in einem Browser können Sie die Ergebnisse bestätigen:
Die URL kopieren -Option können Sie über die drei vertikalen Punkte rechts neben dem beibehaltenen Abfragenamen (ganz links) aufrufen:
Die Löschen ist auch über die drei vertikalen Punkte rechts neben dem beibehaltenen Abfragenamen (ganz links) verfügbar.
Nach dem Entwickeln und Testen Ihrer persistenten Abfrage mit GraphiQL besteht das Endziel darin, Übertragen in die Produktionsumgebung zur Verwendung durch Ihre Anwendungen.
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 einigen Tastaturen Control
Schlüssel wird als Ctrl
.