Une mise en œuvre de l’IDE GraphiQL standard est disponible pour une utilisation avec l’API GraphQL d’Adobe Experience Manager (AEM).
GraphiQL est inclus dans tous les environnements d’AEM (mais est accessible/visible uniquement lorsque vous configurez vos points d’entrée).
Dans les versions précédentes, un package était nécessaire pour installer l’IDE GraphiQL. Si vous l’avez installé, il peut désormais être supprimé.
Vous devez avoir configuré vos points de fin dans le navigateur de configuration avant d’utiliser l’IDE GraphiQL.
L’outil GraphiQL vous permet de tester et de déboguer vos requêtes GraphQL en vous permettant de :
dev-publish
) ;Vous pouvez accéder à l’éditeur de requêtes à partir de :
http://localhost:4502/aem/graphiql.html
Vous pouvez utiliser GraphiQL sur votre système afin que les requêtes puissent être appelées par votre application cliente à l’aide de requêtes GET et pour des requêtes de publication. À des fins de production, vous pouvez ensuite déplacer vos requêtes vers votre environnement de production. Commencez par créer l’auteur de production pour valider le contenu nouvellement créé avec les requêtes, puis publiez la production pour la consommation en direct.
Pour commencer, vous devez sélectionner le Point d’entrée que vous souhaitez utiliser pour les requêtes. Ce point d’entrée est adapté pour la configuration Sites que vous souhaitez utiliser pour vos requêtes.
Il est disponible dans la liste déroulante en haut à droite.
Vous pouvez saisir votre nouvelle requête dans l’éditeur qui se trouve dans le panneau du milieu à gauche, directement sous le logo GraphiQL.
Si une requête persistante est déjà sélectionnée et s’affiche dans le panneau de l’éditeur, sélectionnez +
(en face de Requêtes persistantes) pour vider l’éditeur prêt pour votre nouvelle requête.
Commencez simplement à taper, et l’éditeur :
Les requêtes GraphQL commencent généralement par un caractère {
.
Les lignes qui commencent par un #
sont ignorées.
Utilisez Enregistrer sous pour conserver votre nouvelle requête.
Sélectionnez la requête à mettre à jour dans la liste du panneau des Requêtes persistantes (à l’extrême gauche).
La requête s’affiche dans le panneau de l’éditeur. Apportez les modifications nécessaires, puis utilisez Enregistrer pour valider vos mises à jour dans la requête persistante.
Vous pouvez exécuter une nouvelle requête immédiatement ou charger et exécuter une requête persistante. Pour charger une requête persistante, sélectionnez-la dans la liste ; la requête s’affichera dans le panneau de l’éditeur.
Dans les deux cas, la requête affichée dans le panneau de l’éditeur est la requête qui sera exécutée lorsque vous :
Control-Enter
.L’IDE GraphiQL vous permet également de gérer vos variables de requête.
Par exemple :
Une fois que vous avez sélectionné votre requête persistante dans la liste (panneau de gauche), vous pouvez utiliser les actions Publier et Dépublier. Cette opération les active dans votre environnement de publication (par exemple dev-publish
) pour faciliter l’accès selon vos applications lors des tests.
La définition du paramètre Time To Live
{"cache-control":"parameter":value} du cache de la requête persistante a une valeur par défaut de 2 heures (7 200 secondes).
L’option Copier l’URL vous permet de simuler une requête en copiant l’URL utilisée pour accéder directement à la requête persistante et consulter les résultats. Elle peut ensuite être utilisée à des fins de test ; par exemple, en y accédant par le biais d’un navigateur :
Par exemple :
http://localhost:4502/graphql/execute.json/global/article-list-01
En utilisant cette URL dans un navigateur, vous pouvez confirmer les résultats :
L’option Copier l’URL est accessible à partir des trois points verticaux situés à droite du nom de la requête persistante (panneau tout à gauche) :
L’option Supprimer est également accessible à partir des trois points verticaux situés à droite du nom de la requête persistante (panneau tout à gauche).
Après avoir développé et testé votre requête persistante avec GraphiQL, l’objectif final est de la transférer vers votre environnement de production pour qu’elle soit utilisée par vos applications.
Plusieurs raccourcis clavier permettent d’accéder directement aux icônes d’action dans l’IDE :
Shift-Control-P
Shift-Control-M
Control-Enter
Control-Space
Sur certains claviers, la clé Control
est étiquetée comme Ctrl
.