Indentez et validez GraphQL

Les développeurs utilisent Formateur GraphQL avant une revue de code, une session de débogage ou un passage de relais.

Indentez et validez GraphQL, afin de faciliter la relecture, les modifications et le débogage. Utilisez-le sans compte dans votre navigateur.

Mode d’emploi

Collez votre requête GraphQL dans le champ de saisie, ou importez un fichier .graphql ou .gql.
Vérifiez que la requête est complète et que les accolades sont équilibrées avant de lancer le formatage.
Lancez le formatage pour indenter la requête et repérer une éventuelle erreur de syntaxe.
Comparez la version obtenue avec l'original pour vous assurer que le sens de la requête n'a pas changé.
Effacez le contenu avant de passer à une autre requête ou à un autre fichier.

Exemple

Un développeur colle une requête de lecture comportant plusieurs champs imbriqués, puis lance le formatage avant une revue. Il vérifie que les champs restent dans le même ordre logique et que l'indentation rend les blocs plus faciles à relire.

Limites et formats

L'outil formate et valide la syntaxe GraphQL ; il n'exécute pas la requête et ne contacte aucune API.
Il ne connaît pas votre schéma : une requête bien indentée peut tout de même demander des champs inexistants.
L'import accepte notamment les fichiers .graphql, .gql, .json, .html, .css, .js, .ts, .sql et les fichiers texte, mais le contenu doit rester du GraphQL valide.
Après formatage, relisez les fragments, les variables et les directives pour confirmer que rien d'important n'a été modifié visuellement.

Où le traitement a lieu

Le formatage s'effectue localement dans votre navigateur. La requête saisie ou importée n'est pas envoyée à l'extérieur et reste sur votre appareil pendant l'opération. Vous pouvez donc préparer une revue de code ou corriger l'indentation sans créer de compte.

Questions fréquentes

L'outil vérifie-t-il la validité par rapport à mon schéma ?

Non, il travaille sur la syntaxe de la requête. Il peut signaler une écriture incorrecte, mais il ne sait pas si les champs existent dans votre schéma ni si les types correspondent à votre API.

Puis-je formater une mutation ou une subscription ?

Oui, tant que le texte respecte la syntaxe GraphQL. Le formatage s'applique à la structure de la requête, qu'il s'agisse d'une lecture, d'une mutation ou d'un abonnement, sans exécuter l'opération.

Pourquoi ma requête n'est-elle pas formatée ?

Une erreur de syntaxe, un caractère manquant ou un contenu qui n'est pas du GraphQL peut empêcher un résultat propre. Corrigez d'abord la partie signalée, puis relancez le formatage sur une requête complète.