L’Explorateur API est un EDI intégré au navigateur pour explorer l’API GraphQL d’un projet. Il permet aux développeurs Archie Core de créer et d’exécuter facilement des requêtes GraphQL à partir de l’espace de travail.

L’Explorateur API utilise vos données de production réelles en direct.

---

Introspection

Un schéma GraphQL dispose d’un système d’introspection intégré qui publie la structure du schéma. Cela permet à l’Explorateur API d’offrir de puissantes fonctions d’auto-complétion lors de la rédaction de requêtes GraphQL.

Une fois dans le bloc items, tapez “em”. Il est alors facile de voir et de sélectionner le champ email parmi les opérations disponibles dans l’API. L’auto-complétion est contextuelle par rapport à l’endroit où vous vous trouvez dans la requête en cours de construction et filtre les options selon ce que vous saisissez.

Pour activer manuellement le menu d’auto-complétion et afficher les options disponibles, appuyez sur la combinaison de touches [Shift] + [Espace]. Cette action affiche le menu contextuel et vous permet de sélectionner le champ souhaité, par exemple items, dans la liste.

De plus, l’introspection aide à détecter les erreurs dans les requêtes. Le système reconnaît lorsque les types ne sont pas disponibles ou sont mal configurés — par exemple, Number devrait être String, champ non disponible sur la table, ainsi que les validations. Par conséquent, lorsque vous utilisez l’Explorateur API, survolez les lignes ondulées rouges pour afficher les infobulles d’erreur.

Accéder à la documentation de l’API

L’Explorateur API comprend une référence de schéma intégrée pour vous aider à comprendre votre modèle de données pendant que vous rédigez des requêtes. Il existe deux façons d’y accéder :

1. Le panneau de documentation

Cliquez sur le bouton Documentation situé dans la barre d’outils en haut à droite. Cela affiche une barre latérale à gauche où vous pouvez parcourir et rechercher toutes les Queries, Mutations et Types disponibles.

2. Navigation rapide contextuelle

Comme le montre l’image, vous pouvez accéder directement à la documentation d’un champ précis que vous êtes en train de saisir :

• Survolez un nom de champ (p. ex. cities) dans l’éditeur. Une infobulle affiche son type de retour (p. ex. CitiesConnection).
• Cliquez sur le nom du type dans l’infobulle.
• Le panneau Documentation s’ouvre automatiquement et affiche la définition de ce type, avec tous les sous-champs disponibles (comme items, count, aggregates) et leurs descriptions.

Composer

Le Composer est un outil visuel de construction de requêtes qui est généralement ouvert par défaut sur le côté gauche de l’Explorateur API. Il vous permet de sélectionner des champs et des arguments pour générer automatiquement une syntaxe GraphQL valide.

Si vous avez fermé le panneau ou ne le voyez pas, vous pouvez le rouvrir ainsi :

• Repérez le bouton Composer dans la barre d’outils en haut à droite.
• Il est placé immédiatement à côté du bouton Documentation.
• Un clic sur ce bouton affiche ou masque la barre latérale Composer et ramène l’éditeur visuel à l’écran.

Essayez d’ouvrir cities et de cocher l’option count. La requête suivante remplira la zone de texte ; vous pouvez l’exécuter pour vérifier combien de villes il y a.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}