Pontos-chave
- 01Formata consultas, mutações, subscrições e esquemas SDL usando o analisador graphql.js oficial.
- 02Valida a sintaxe e relata a linha e coluna exatas dos erros — nenhum esquema necessário.
- 03Comentários GraphQL (#) são removidos durante a formatação; use strings de descrição para documentação que você deseja preservar.
- 04Executa inteiramente no seu navegador — consultas de API internas e esquemas proprietários permanecem privados.
Por Que Formatar Documentos GraphQL?
As consultas GraphQL podem ficar complexas rapidamente — fragmentos aninhados, variáveis inline, múltiplas definições de operação e definições de tipo SDL com interfaces e diretivas. A formatação consistente torna a revisão por pares mais rápida e facilita a detecção de chaves de fechamento ausentes ou incompatibilidades de argumentos à primeira vista.
O formatador usa o analisador de referência graphql.js — o mesmo analisador que a especificação GraphQL fornece. Isso significa que a formatação canônica que você obtém aqui corresponde ao que o plugin GraphQL do Prettier e a maioria das ferramentas GraphQL produzem. Qualquer coisa que analise corretamente aqui será analisada corretamente no Apollo, Relay e graphql-request.
Como Formatar um Documento GraphQL
- 01
Cole seu GraphQL
Cole uma consulta, mutação, subscrição, fragmento ou definição de esquema SDL no painel de entrada.
- 02
Clique em Formatar
O analisador emite o documento com indentação canônica — indentação de dois espaços, um campo por linha, alinhamento de argumentos consistente. O resultado aparece no painel de saída.
- 03
Valide opcionalmente
Clique em Validar para confirmar que o documento é analisado sem produzir uma saída formatada. O resultado é uma confirmação ou uma lista de erros de sintaxe com números de linha e coluna.
- 04
Copie o resultado
Clique em Copiar para obter o documento formatado. Cole-o em sua base de código, descrição de PR ou arquivo de documentação.
Seguro para Esquemas Internos e Consultas de API
O analisador graphql.js executa inteiramente no seu navegador. Nenhum texto de operação ou definição de esquema é enviado para nenhum servidor. Isso o torna seguro para formatar consultas que fazem referência a nomes de campo privados ou sistemas de tipo internos que você não deseja expor a ferramentas de terceiros.
A validação aqui é apenas sintática — a ferramenta verifica se o documento é um documento GraphQL válido, mas não verifica se os nomes dos campos existem em um esquema real, se as variáveis correspondem aos tipos de argumentos ou se as diretivas são aplicadas corretamente. A validação com reconhecimento de esquema requer que o esquema de destino seja carregado junto com o documento.
Perguntas Frequentes sobre o Formatador GraphQL
A formatação GraphQL valida contra um esquema?
Não — apenas validação de sintaxe. Verificar se campos e argumentos existem requer o esquema de destino. Esta ferramenta confirma que o documento é um documento GraphQL válido, nada mais.
Os comentários no meu GraphQL serão preservados?
Não. As linhas começando com # são removidas pelo analisador. Use strings de descrição entre aspas triplas para documentação que deve sobreviver à formatação.
Qual versão da especificação GraphQL é suportada?
A especificação de outubro de 2021, incluindo objetos de entrada OneOf e a diretiva @specifiedBy.
Posso formatar definições de esquema SDL, não apenas documentos de operação?
Sim. Definições de tipo, declarações de interface, tipos de união, enumerações, diretivas e descrições funcionam corretamente através do formatador.
A consulta ou esquema é enviado para algum lugar?
Não. O analisador graphql.js executa inteiramente no seu navegador — nada sai do seu dispositivo.