Comment tester une API GraphQL dans VS Code

Par Sayaib SarkarMis à jour le 3 min de lecture

Sur cette page 6 sections

Réponse courte : une requête GraphQL est un POST HTTP avec un corps JSON contenant la requête, ses variables et, éventuellement, un nom d’opération. N’importe quel client REST qui comprend GraphQL peut l’envoyer. Ce guide utilise le REST API Client gratuit de DevSnip Pro, qui dispose d’un mode GraphQL avec des champs séparés pour la requête, les variables et le nom d’opération.

1. Passer le client en mode GraphQL

  1. Lancez DevSnip Pro: REST API Client depuis la palette de commandes (Ctrl/Cmd+Shift+P).
  2. Passez le protocole de HTTP à GraphQL (à côté du nom de la requête). L’onglet Body est remplacé par un onglet Query.
  3. Choisissez la méthode POST et saisissez l’endpoint, par exemple https://countries.trevorblades.com/ (une API de démonstration publique) ou {{baseUrl}}/graphql.

Si la méthode est GET, le client signale que la requête ne sera pas envoyée et propose Use POST.

2. Écrire la requête et les variables

Dans le champ Query :

GraphQL
query GetCountry($code: ID!) {
  country(code: $code) {
    name
    capital
    currency
  }
}

Dans Variables (JSON) :

JSON
{ "code": "DE" }

Le champ des variables est vérifié pendant la saisie : un JSON invalide est signalé avant l’envoi. Renseignez Operation name (GetCountry) quand le document contient plusieurs opérations.

3. Envoyer et lire la réponse

Appuyez sur Ctrl/Cmd+Enter ou sur Send. Les serveurs GraphQL répondent généralement 200 OK même quand la requête échoue, alors lisez le corps :

  • data contient le résultat ;
  • errors liste les problèmes avec un message et un chemin. Une réponse peut contenir les deux, ce qui signifie un résultat partiel.

4. Ajouter l’authentification et les environnements

Les API GraphQL utilisent la même authentification que les API REST. Placez le token dans une variable d’environnement et réglez l’authentification Bearer sur {{token}} ; changez d’environnement pour exécuter la même requête en local et en staging. Enregistrez la requête dans une collection pour qu’elle serve de documentation.

5. Formater les requêtes et générer des types

Ouvrez GraphQL Formatter & Types depuis la section Backend & API de la barre latérale Tools :

  • Query: format & request formate ou minifie une requête, liste ses opérations et ses variables, et construit le corps JSON de la requête, une commande cURL et un appel fetch. Il signale les fragments non définis ou inutilisés et les opérations sans nom.
  • Schema (SDL) → TypeScript transforme un schéma en types TypeScript. Pour des opérations entièrement typées, GraphQL Code Generator va plus loin.

Les limites à connaître

  • Il n’y a ni explorateur de schéma ni autocomplétion par introspection ; écrivez la requête vous-même ou collez-la depuis votre code.
  • Les subscriptions GraphQL via WebSocket n’ont pas de mode dédié. L’outil WebSocket du client est une fonctionnalité avancée payante en points.

Essayez-le dans votre propre éditeur

Gratuit, sans compte, en local. Pour VS Code 1.93+ et les IDE JetBrains sous Windows, macOS ou Linux.

code --install-extension sayaib.hue-console