01
Use o modo adequado ao texto
Para formatar queries, mutations, subscriptions e fragmentos, escolha Operações. Um type ou extend isolado pode ser formatado em SDL sem uma raiz Query. O modo Variáveis funciona sozinho, sem exigir uma query.
Documentos GraphQL
Formatador GraphQLentenda o que foi validado
Trabalhe com operações, SDL ou variáveis JSON. Para verificar os campos de uma operação, forneça um schema completo em SDL.
Formatador GraphQL
Entrada
Resultado
Os documentos são processados neste navegador, sem requisições à API, histórico salvo ou dados de entrada nas URLs.
Opções
Sem schema: apenas sintaxe. Com SDL completo: verificação estática de campos e tipos. As variáveis são verificadas como objeto JSON, sem conferir o tipo dos valores.
Documento e schema: 100.000 caracteres cada; variáveis: 20.000. GraphQL: 20.000 tokens, 100 níveis de aninhamento; interrupção após 8 segundos.
Insira um documento ou carregue um exemplo.
O Formatador GraphQL ajuda a revisar queries copiadas de logs. Ele organiza seleções aninhadas e mantém as definições de fragmentos no documento, sem substituir a entrada original. Assim fica mais fácil acompanhar as referências durante a revisão.
Uma query bem formatada ainda pode pedir um campo inexistente. O status informa se houve apenas análise de sintaxe ou validação estática com o schema fornecido; nenhum desses resultados prevê a resposta do servidor.
Por que usar este Formatador GraphQL
Revisar definições no mesmo lugar
O Formatador GraphQL usa recuo de dois espaços e imprime o documento inteiro. A estrutura lista operações, declarações de variáveis, fragmentos e campos com as linhas de origem. Referências não são expandidas nem completadas com conteúdo inventado.
Conferir os campos com o contrato
Para validar GraphQL além da gramática, adicione o schema GraphQL completo. Com ele, a ferramenta consegue apontar campos desconhecidos, argumentos e relações incompatíveis entre tipos ou fragmentos, indicando qual entrada precisa de ajuste.
Escolha o alcance da revisão
02
Complete as entradas de contexto
As abas Documento, Schema e Variáveis preservam seus próprios textos. O exemplo inclui os três. Antes de aplicar, confira a prévia dos novos valores e a contagem de caracteres; Desfazer recupera também o resultado anterior.
03
Exporte o cálculo atual
O modo automático espera 400 ms após uma edição. Desligue-o para usar o botão ou Ctrl/Cmd+Enter. Qualquer mudança de entrada bloqueia a exportação até um novo processamento válido; alternar a visualização reutiliza o cálculo atual.
Saídas para leitura e inspeção
Formatação e minificação
O recuo facilita o code review. Ao minificar GraphQL, a ferramenta remove separadores dispensáveis, mantendo espaços obrigatórios entre nomes, valores das strings e a ordem dos campos. Ela não reescreve a operação para otimizar sua execução.
Estrutura com linhas de origem
Operações, variáveis declaradas, fragmentos, campos e tipos SDL aparecem em lotes de 100 itens. A exportação da estrutura em JSON inclui a lista completa, mesmo com linhas ainda ocultas. O número de itens não representa custo de consulta.
Variáveis sem arredondamento
Os números 9007199254740993 e 1.2300e+40 preservam sua escrita. As chaves mantêm a ordem de entrada, inclusive quando parecem números. Chaves duplicadas são recusadas, evitando descartar um valor sem aviso.
Diagnósticos que apontam a entrada
Erros de sintaxe mostram linha e coluna quando disponíveis. Clique no erro para abrir a aba correspondente. Quando apenas a validação do schema falha, o documento formatado continua visível para correção, mas copiar e baixar ficam desativados.
O que a validação não garante
- Não há execução ou conversão de valores
- A ferramenta não executa resolvers nem consulta o servidor. Não verifica valores obrigatórios, coerção em runtime, escalares personalizados ou regras de negócio das variáveis. Os tipos declarados no documento fazem parte da validação estática.
- O schema opcional exige SDL completo
- Não há importação de JSON de introspecção nem de URLs. Inclua a raiz de query, os tipos referenciados e as definições de diretivas próprias. Composição Federation e geração de código ficam fora do escopo. O modo SDL independente verifica apenas sintaxe.
- Comentários diferem de descrições
- As saídas formatada e minificada removem comentários #. Descrições SDL em strings são preservadas como parte da sintaxe. A entrada original permanece disponível; não há reparo automático, ordenação de campos nem busca de fragmentos externos.
- Limites interrompem o processamento
- Documento e schema aceitam 100.000 caracteres cada; variáveis, 20.000. GraphQL aceita até 20.000 tokens e 100 níveis de delimitadores; JSON também tem limite de 100 níveis. Após 8 segundos, o worker é encerrado. Divida documentos maiores e tente novamente.
Dúvidas sobre o Formatador GraphQL
Como conferir a sintaxe GraphQL do texto inserido em um editor?
Um parser consegue verificar a gramática sem conhecer o schema. Em Operações, deixe o schema vazio para analisar apenas a sintaxe. Isso não comprova que os campos existam no servidor.
Como validar operações GraphQL com o schema do servidor?
Cole o SDL completo do servidor na aba Schema e a operação com seus fragmentos em Documento. As regras estáticas verificam campos, argumentos e tipos declarados. Elas não testam autenticação, execução ou comportamento dos resolvers.
Por que minhas variáveis GraphQL são consideradas um JSON inválido?
Variáveis usam JSON estrito, não a notação de objetos do GraphQL nem dicionários de outra linguagem. Use aspas duplas em chaves e strings, remova vírgulas finais e forneça um objeto na raiz. Chaves duplicadas também são rejeitadas.
Por que aparece o erro “Query root type must be provided”?
O schema informado como completo não tem uma raiz de query válida. Defina type Query ou aponte para um tipo objeto existente em uma declaração schema. Para formatar apenas um tipo ou uma extensão isolados, use o modo SDL.
Por que a definição do fragmento não aparece ao imprimir uma query GraphQL?
Imprimir só o nó da operação não adiciona definições que estejam em outro lugar. Aqui é impresso todo o documento colado. Inclua os fragmentos necessários no mesmo texto; a ferramenta não lê arquivos externos nem expande as referências.
Seu documento gerou um resultado inesperado?
Prepare a próxima revisão
Use o Formatador GraphQL, confira o alcance indicado no status e exporte a visualização atual quando estiver pronta.