Utilisation de l’IDE GraphiQL

Une mise en œuvre de l’IDE GraphQL standard est disponible pour une utilisation avec l’API GraphQL d’Adobe Experience Manager (AEM) as a Cloud Service.

REMARQUE

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 module était nécessaire pour installer l’IDE GraphiQL. Si vous l’avez installé, il peut désormais être supprimé.

REMARQUE

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 :

  • sélectionner le Point d’entrée approprié pour la configuration Sites que vous souhaitez utiliser pour vos requêtes ;
  • saisir directement de nouvelles requêtes ;
  • créer et accéder aux Requêtes persistantes ;
  • exécuter vos requêtes pour afficher immédiatement les résultats ;
  • gérer les Variables de requête ;
  • enregistrer et gérer les Requêtes persistantes ;
  • publier ou annuler la publication de Requêtes persistantes (par exemple : vers et à partir de dev-publish) ;
  • Afficher l’Historique de vos requêtes précédentes ;
  • utiliser l’Explorateur de documentation pour accéder à la documentation pour vous aider à apprendre et à comprendre les méthodes disponibles.

Vous pouvez accéder à l’éditeur de requêtes à partir de :

  • Outils -> Général -> Éditeur de requêtes GraphQL
  • directement ; par exemple, http://localhost:4502/aem/graphiql.html
Interface GraphiQL

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.

Sélection de votre point d’entrée

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.

Création et persistance d’une nouvelle requête

Vous pouvez saisir votre nouvelle requête dans l’éditeur qui se trouve dans le panneau du milieu à gauche, directement sous le logo GraphiQL.

REMARQUE

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 :

  • offre une fonctionnalité de survol de la souris pour afficher des informations supplémentaires sur les éléments ;
  • offre des fonctionnalités telles que la mise en surbrillance de la syntaxe, la saisie automatique et la suggestion automatique.
REMARQUE

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.

Mise à jour de la requête persistante

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.

Exécution de requêtes

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 :

  • cliquez ou appuyez sur l’icône Exécuter la requête ;
  • utilisez la combinaison de clavier Control-Enter.

Variables de requête

L’IDE GraphiQL vous permet également de gérer vos variables de requête.

Par exemple :

Variables GraphQL

Gérer le cache pour vos requêtes persistantes

Les requêtes persistantes sont recommandées, car elles peuvent être mises en cache au niveau des couches Dispatcher et réseau CDN, ce qui améliore les performances de l’application cliente effectuant les requêtes. Par défaut, AEM invalidera le cache du réseau de diffusion de contenu (CDN) en fonction d’une durée de vie par défaut (TTL).

REMARQUE

Les règles de réécriture personnalisées sur Dispatcher peuvent remplacer les valeurs par défaut de la publication AEM.

Si vous envoyez des en-têtes de contrôle du cache TTL à partir du Dispatcher, en fonction d’un modèle de correspondance d’emplacement, vous pouvez alors, si nécessaire, exclure . /graphql/execute.json/* des correspondances.

Avec GraphQL, vous pouvez configurer les en-têtes de cache HTTP pour contrôler ces paramètres pour votre propre requête persistante.

  1. L’option En-têtes est accessible à partir des trois points verticaux situés à droite du nom de la requête persistante (panneau tout à gauche) :

    En-têtes de cache HTTP de requêtes persistantes
  2. Si vous sélectionnez cette option, la boîte de dialogue Configuration du cache s’ouvre :

    Paramètres d’en-tête de cache HTTP de requête persistante
  3. Sélectionnez le paramètre approprié, puis ajustez la valeur selon les besoins :

    • cache-control - max-age
      Les caches peuvent stocker ce contenu pendant un nombre de secondes spécifié. Il s’agit généralement de la durée de vie (TTL) du navigateur.
    • surrogate-control - s-maxage
      Identique à max-age, mais s’applique spécifiquement aux caches de proxy.
    • surrogate-control - stale-while-revalidate
      Les caches peuvent continuer à servir une réponse mise en cache après qu’elle est devenue obsolète, jusqu’au nombre de secondes spécifié.
    • surrogate-control - stale-if-error
      Les caches peuvent continuer à servir une réponse mise en cache en cas d’erreur d’origine, jusqu’au nombre de secondes spécifié.
  4. Sélectionnez Enregistrer pour conserver les modifications.

Publier des requêtes persistantes

Une fois que vous avez sélectionné votre requête persistante dans la liste (panneau de gauche), vous pouvez utiliser les actions Publier et Annuler la publication. 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.

REMARQUE

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).

Copie de l’URL pour accéder directement à la requête

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 :

GraphiQL - Copier l’URL

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

GraphiQL - Copier l’URL

Suppression de requêtes persistantes

L’option Supprimer est également accessible à partir des trois points verticaux situés à droite du nom de la requête persistante (panneau tout à gauche).

Installation de la requête persistante en production

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.

Raccourcis clavier

Plusieurs raccourcis clavier permettent d’accéder directement aux icônes d’action dans l’IDE :

  • Embellir la requête : Shift-Control-P
  • Fusionner la requête : Shift-Control-M
  • Exécuter la requête : Control-Enter
  • Remplissage automatique : Control-Space
REMARQUE

Sur certains claviers, la clé Control est étiquetée comme Ctrl.

Sur cette page