Points clés
- 01Formate les requêtes, mutations, abonnements et schémas SDL en utilisant l'analyseur officiel graphql.js.
- 02Valide la syntaxe et signale la ligne et la colonne exactes des erreurs — aucun schéma requis.
- 03Les commentaires GraphQL (#) sont supprimés lors du formatage ; utilisez des chaînes de description pour la documentation que vous souhaitez conserver.
- 04S'exécute entièrement dans votre navigateur — les requêtes d'API internes et les schémas propriétaires restent privés.
Pourquoi formater les documents GraphQL ?
Les requêtes GraphQL peuvent devenir complexes rapidement — fragments imbriqués, variables en ligne, plusieurs définitions d'opérations et définitions de types SDL avec interfaces et directives. Un formatage cohérent accélère la révision par les pairs et facilite la détection des accolades manquantes ou des incompatibilités d'arguments en un coup d'œil.
Le formateur utilise l'analyseur de référence graphql.js — le même analyseur que celui fourni avec la spécification GraphQL. Cela signifie que le formatage canonique que vous obtenez ici correspond à ce que produit le plugin GraphQL de Prettier et la plupart des outils GraphQL. Tout ce qui s'analyse correctement ici s'analysera correctement dans Apollo, Relay et graphql-request.
Comment formater un document GraphQL
- 01
Collez votre GraphQL
Collez une requête, mutation, abonnement, fragment ou définition de schéma SDL dans le panneau d'entrée.
- 02
Cliquez sur Formater
L'analyseur émet le document avec une indentation canonique — indentation de deux espaces, un champ par ligne, alignement cohérent des arguments. Le résultat apparaît dans le panneau de sortie.
- 03
Validez optionnellement
Cliquez sur Valider pour confirmer que le document s'analyse sans produire de sortie formatée. Le résultat est une confirmation ou une liste d'erreurs de syntaxe avec les numéros de ligne et de colonne.
- 04
Copiez le résultat
Cliquez sur Copier pour récupérer le document formaté. Collez-le dans votre base de code, une description de PR ou un fichier de documentation.
Sûr pour les schémas internes et les requêtes d'API
L'analyseur graphql.js s'exécute entièrement dans votre navigateur. Aucun texte d'opération ou définition de schéma n'est envoyé à un serveur. Cela le rend sûr pour formater les requêtes qui font référence à des noms de champs privés ou à des systèmes de types internes que vous ne souhaitez pas exposer à des outils tiers.
La validation ici est syntaxique uniquement — l'outil vérifie que le document est un document GraphQL valide, mais il ne vérifie pas si les noms de champs existent dans un vrai schéma, si les variables correspondent aux types d'arguments ou si les directives sont appliquées correctement. La validation consciente du schéma nécessite que le schéma cible soit chargé aux côtés du document.
FAQ du formateur GraphQL
Le formatage GraphQL valide-t-il par rapport à un schéma ?
Non — validation syntaxique uniquement. Vérifier si les champs et les arguments existent nécessite le schéma cible. Cet outil confirme que le document est un document GraphQL valide, rien de plus.
Les commentaires dans mon GraphQL seront-ils préservés ?
Non. Les lignes commençant par # sont supprimées par l'analyseur. Utilisez des chaînes de description entre guillemets triples pour la documentation qui doit survivre au formatage.
Quelle version de la spécification GraphQL est prise en charge ?
La spécification d'octobre 2021, incluant les objets d'entrée OneOf et la directive @specifiedBy.
Puis-je formater les définitions de schéma SDL, pas seulement les documents d'opération ?
Oui. Les définitions de types, les déclarations d'interface, les types d'union, les énumérations, les directives et les descriptions font tous l'aller-retour correctement à travers le formateur.
La requête ou le schéma est-il envoyé quelque part ?
Non. L'analyseur graphql.js s'exécute entièrement dans votre navigateur — rien ne quitte votre appareil.