Documents GraphQL

Formateur GraphQLlire avant de valider

Choisissez les opérations, le SDL ou les variables JSON. Ajoutez un schéma SDL complet pour vérifier les champs de vos opérations.

Formateur GraphQL

Entrée

Résultat

Les documents sont traités dans ce navigateur, sans requête API, historique enregistré ni entrée ajoutée aux URL.

Options

Sans schéma : syntaxe uniquement. Avec un SDL complet : contrôles statiques des champs et des types. Les variables sont vérifiées comme objet JSON, sans contrôle du type de leurs valeurs.

Document et schéma : 100 000 caractères chacun ; variables : 20 000. GraphQL : 20 000 tokens, 100 niveaux d’imbrication ; arrêt après 8 secondes.

Saisissez un document ou chargez un exemple.

Le Formateur GraphQL rend lisible une requête récupérée dans un journal. Les sélections imbriquées et les fragments restent dans le même document, ce qui permet de suivre les références pendant une revue sans écraser le texte d’origine.

Une requête bien présentée peut demander un champ absent de votre API. Le statut précise donc si le contrôle porte uniquement sur la syntaxe ou également sur le schéma que vous avez fourni.

Pourquoi utiliser ce Formateur GraphQL

Garder le contexte des fragments

Le Formateur GraphQL indente les sélections avec deux espaces et imprime le document entier. La structure montre les opérations, variables et fragments avec leurs lignes d’origine. Les références ne sont ni développées ni complétées par des définitions inventées.

Un document compact devient une série de lignes indentées, à côté d’une carte distincte pour les variables.

Contrôler les champs avec le bon contrat

Le schéma GraphQL apporte les types nécessaires pour repérer un champ inconnu ou une sélection incompatible. Collez un SDL complet dans l’entrée facultative pour aller au-delà de la grammaire et retrouver l’origine d’une erreur.

Une requête passe le contrôle de syntaxe, puis un schéma révèle un champ incompatible surligné en corail.

Choisir ce que vous souhaitez vérifier

01

Distinguer opération et définition de type

Pour formater une requête GraphQL, choisissez Opérations, qui accepte aussi mutations, abonnements et fragments. Le mode SDL accepte un type ou une extension isolés sans exiger de racine Query. Le mode Variables fonctionne sans document GraphQL.

02

Ajouter le contexte dans les onglets

En mode Opérations, les entrées Document, Schéma et Variables conservent chacune leur contenu. L’exemple fournit les trois. Son aperçu indique le texte et le nombre de caractères remplacés avant application ; le retour à l’état précédent restaure aussi le résultat.

03

Vérifier la fraîcheur du résultat

L’automatisation attend 400 ms après la dernière modification. Désactivez-la pour utiliser le bouton ou Ctrl/Cmd+Entrée. Les changements d’entrée rendent le résultat périmé ; changer seulement de vue ne relance pas le calcul.

Des sorties adaptées à la lecture

Présentation et minification

L’indentation facilite la revue. Pour minifier GraphQL, le parseur retire les séparateurs superflus en conservant les espaces nécessaires entre noms, la valeur des chaînes et l’ordre des champs. Il ne réécrit pas la requête pour en réduire le coût.

Structure reliée au texte source

Opérations, déclarations de variables, fragments, champs et types SDL sont listés avec leurs lignes. La vue affiche 100 éléments supplémentaires à chaque demande. Son téléchargement JSON comprend la liste entière, même les éléments encore masqués.

Variables sans arrondi des nombres

Les variables JSON gardent les écritures 9007199254740993 et 1.2300e+40. Les clés restent dans leur ordre d’origine, y compris celles qui ressemblent à des nombres. Une clé répétée est refusée au lieu d’effacer silencieusement une valeur.

Diagnostic et texte de travail

Les erreurs de syntaxe indiquent la ligne et la colonne lorsqu’elles sont disponibles. Cliquez sur une erreur pour ouvrir la bonne entrée. Une erreur de schéma laisse le texte formaté visible pour correction, mais bloque la copie et le téléchargement.

Ce que le résultat ne garantit pas

Un contrôle statique ne lance pas l’opération
Aucun appel de résolveur ne permet de prédire une réponse. Les valeurs obligatoires, conversions à l’exécution, scalaires personnalisés et règles métier ne sont pas vérifiés pour les variables. Leurs types déclarés dans le document font partie des contrôles statiques.
Le schéma facultatif doit être un SDL complet
Les réponses JSON d’introspection et les URL ne sont pas importées. Incluez la racine de requête, les types référencés et vos définitions de directives. La composition Federation et la génération de code sont hors périmètre. Le mode SDL indépendant vérifie seulement la syntaxe.
Les commentaires ne sont pas des descriptions
Les sorties formatée et minifiée retirent les commentaires #. Les descriptions SDL sous forme de chaînes restent présentes. Le texte d’entrée est conservé, sans réparation automatique, tri des champs ni recherche de fragments dans d’autres fichiers.
Des limites explicites de traitement
Document et schéma sont limités chacun à 100 000 caractères, variables à 20 000. GraphQL accepte au plus 20 000 tokens et 100 niveaux de délimiteurs ; JSON est aussi limité à 100 niveaux. Le worker s’arrête après 8 secondes : fractionnez un gros document et réessayez.

Questions sur le Formateur GraphQL

Comment vérifier la syntaxe GraphQL saisie dans un éditeur ?

Un parseur peut vérifier la grammaire sans connaître le schéma. En mode Opérations, laissez le schéma vide pour ce contrôle seul. Un résultat positif ne prouve pas que les champs existent sur votre serveur.

Comment valider des opérations GraphQL avec le schéma du serveur ?

Collez le SDL complet du serveur dans l’onglet Schéma et l’opération avec ses fragments dans Document. Les règles statiques comparent les champs, arguments et types déclarés. Elles ne testent ni l’authentification, ni l’exécution, ni les résolveurs.

Pourquoi mes variables GraphQL sont-elles signalées comme du JSON invalide ?

Les variables utilisent du JSON strict, et non la notation d’objet GraphQL ou le dictionnaire d’un langage. Entourez les clés et chaînes de guillemets doubles, retirez les virgules finales et fournissez un objet à la racine. Les clés en double sont également refusées.

Pourquoi le message « Query root type must be provided » apparaît-il ?

Le schéma fourni comme complet ne possède pas de racine de requête valide. Définissez type Query ou indiquez un type objet existant dans une déclaration schema. Pour mettre en forme un type ou une extension isolés, choisissez plutôt le mode SDL.

Pourquoi la définition du fragment manque-t-elle dans la requête GraphQL imprimée ?

L’impression d’un seul nœud d’opération ne peut pas ajouter des définitions situées ailleurs. Cet outil imprime tout le document collé : ajoutez donc les fragments nécessaires au même texte. Il ne charge pas de fichiers externes et ne développe pas les références.

Un résultat inattendu avec votre document ?

Préparer la prochaine revue

Utilisez le Formateur GraphQL, vérifiez la portée annoncée par le statut, puis exportez la vue qui vous convient.