Tester les API GraphQL avec l’explorateur GraphQL

Testez la requête de vos API GraphQL à l’aide d’un outil de test GraphQL intégré.

Avant de commencer

Créez un schéma pour votre API GraphQL. Pour plus d'informations, consultez Créer un schéma GraphQL.

L’activation des requêtes introspectives permet à l’explorateur GraphQL d’afficher les schémas sur l’instance dans l’explorateur de documentation et sous forme de suggestions de saisie semi-automatique, ce qui facilite la recherche de requêtes et de mutations. Pour plus d'informations, consultez Activer les requêtes introspectives pour les schémas GraphQL.

Remarque :

N’utilisez pas de requêtes introspectives dans un environnement de production.

Rôle requis : graphql_schema_admin ou admin

Pourquoi et quand exécuter cette tâche

L’explorateur GraphQL intègre l’IDE GraphiQL dans le Now Platformfichier . Pour plus d’informations sur l’interface, consultez le fichier readme GraphiQL dans le référentiel GraphiQL GitHub .

Procédure

1. Accédez à la Tout > Services web du système > GraphQL > Explorateur GraphQL.
2. Facultatif : Si vous avez activé l’introspection, dans la barre latérale gauche, sélectionnez l’icône Afficher l’explorateur de documentation (icône ) pour afficher et rechercher des requêtes ou des mutations disponibles.
3. Dans l’éditeur, entrez une requête dans le schéma.

   Incluez les espaces de noms de l’application et du schéma dans la requête. Pour en savoir plus sur les directives que vous pouvez appliquer, reportez-vous à la section Directives et fonctions globales.

   Cet exemple montre l’utilisation des espaces de noms d’application et de schéma :

   • Espace de nom de l’application : x_graph_scope
   • Espace de noms du schéma : planet

   query {
     x_graph_scope {
       planet {
         findAll {
           name
           mass
           distance
         }
       }
     }
   }

   Cet exemple montre l’utilisation de la directive @defer pour diffuser les résultats du champ openedBy après la réponse à l’incident initiale.

   query findIncidents {
     now {
       incident {
         findAll {
           description {
             displayValue
           }
           ...
           @defer(label: "my-label", if: true) {
             openedBy {
               firstName
               lastName
             }
           }
         }
       }
     }
   }

4. Facultatif : En bas de l’éditeur, sélectionnez Variables et entrez toutes les variables nécessaires.
5. Sélectionnez l’icône Exécuter la requête (icône ).
   Conseil :

   Vous pouvez également utiliser un raccourci clavier. Pour afficher la liste des raccourcis clavier disponibles, sélectionnez l’icône Ouvrir la boîte de dialogue des touches ).
   Le résultat de votre requête est renvoyé dans le volet droit.
6. Facultatif : Sélectionnez l’icône Ajouter un onglet ( ) pour exécuter des requêtes supplémentaires.

Que faire ensuite

Si vous avez besoin d’afficher une liste des requêtes précédentes, dans la barre latérale gauche, sélectionnez l’icône Afficher l’historique ( icône ).

Pour accéder aux données d’enregistrement dans un composant, vous pouvez créer un composant personnalisé et interroger votre schéma GraphQL scripté à partir du composant. Pour plus d'informations, consultez Interroger un schéma GraphQL à partir d’un composant.