Test d'une API GraphQL avec l'onglet Test

Pour une définition d'API GraphQL, l'onglet Test contient un éditeur GraphiQL. Vous pouvez utiliser l'éditeur GraphiQL pour aider à construire une requête GraphQL. Lorsque vous testez votre API GraphQL, la réponse s'affiche dans l'éditeur GraphiQL.

Vous pouvez tester une requête GraphQL de l'une des manières suivantes :

Pour chaque type d'opération, vous pouvez tester la requête par rapport au noeud final de l'API GraphQL lui-même, ou par rapport au noeud final de coût qui renvoie les détails sur le coût d'une requête sur le noeud final de l'API GraphQL.

Quelle que soit la méthode et le noeud final que vous utilisez, vous pouvez soit fournir directement la requête, soit utiliser l'éditeur GraphiQL pour aider à construire la requête. L'éditeur fournit une aide à la saisie semi-automatique basée sur le schéma défini pour l'API et met en évidence les erreurs avec des suggestions de correction. Le schéma a été initialement téléchargé lors de la création de la définition de l'API GraphQL, mais il a pu être modifié ultérieurement. Pour plus de détails sur la création d'une définition d'API GraphQL , voir Création d'une API de proxy GraphQL. Pour plus de détails sur la modification du schéma, voir Utilisation de l'éditeur de schéma GraphQL.

Avant de commencer

Voir Préparation d'une API pour le débogage avec l'onglet Test pour connaître les exigences que votre définition d'API doit remplir pour que vous puissiez la tester avec l'onglet Test.

Procédure

1. Dans la section Demande, sélectionnez le type d'opération et le noeud final requis, par exemple :
   • POST https://myserver.com/myorg/sandbox/mybasepath/graphql
   • GET https://myserver.com/myorg/sandbox/mybasepath/graphql/cost
2. Dans l'onglet GraphiQL dans le volet gauche de l'éditeur, fournissez la requête; par exemple :

   {
     accounts(limit: 100) {
       name {
         first
         last
       }
     }
   }

3. Si nécessaire, vous pouvez fournir d'autres en-têtes de requête dans l'onglet Paramètres.
4. Si votre requête inclut des variables, vous pouvez fournir des valeurs pour les variables dans le panneau des Variables de requête. Par exemple, si la requête est la suivante :

   query MyQuery($Query__accounts__limit: Int)
   {
     accounts(limit: $Query__accounts__limit) {
       name {
         first
         last
       }
     }
   }

   Vous pouvez définir une valeur pour Query__accounts__limit en entrant ce qui suit dans la sous-fenêtre Variables de requête :

   {
     "Query__accounts__limit": variable_value
   }

   où valeur_variable est la valeur requise.
5. Cliquez sur Envoyerou sur l'icône Exécuter la requête dans l'éditeur. La réponse s'affiche dans l'éditeur GraphiQL et la section Trace indique comment l'appel API a été exécuté. Pour plus de détails sur les informations de trace, voir Examiner la trace.