Como usar: Formatador e Validador GraphQL
- Cole uma query, mutation, subscription, fragment ou schema GraphQL (SDL).
- Ele é formatado enquanto você digita; erros de sintaxe mostram a linha e a coluna.
- Se quiser, abra Validar contra um schema e cole seu SDL para checar cada campo e argumento.
- Copie o resultado formatado ou minificado.
O que o validador verifica
Sem um schema, a ferramenta verifica a sintaxe: chaves balanceadas, nomes válidos, sintaxe de argumentos e variáveis, escapes de strings e de block strings. Com um schema, ela executa o conjunto completo de regras de validação do GraphQL definidas na especificação, as mesmas que um servidor GraphQL aplica antes de executar uma query:
- Todo campo existe no seu tipo, e campos folha (scalars, enums) não têm seleção de subcampos, enquanto campos de objeto têm.
- Os argumentos existem, os obrigatórios são informados e os valores têm o tipo correto.
- As variáveis são declaradas, usadas, e seus tipos são compatíveis com onde são usadas.
- Os fragments são usados, combinam com o tipo em que são espalhados e não formam ciclos.
- Os nomes de operações são únicos e operações anônimas ficam sozinhas.
Formatação e minificação
A formatação usa a função de referência print do graphql-js, então a saída é igual à da maioria das ferramentas GraphQL: indentação de dois espaços, um campo por linha e espaçamento de argumentos padronizado. A minificação remove comentários e espaços em branco irrelevantes, útil para requisições GET e persisted queries, onde cada byte conta. Precisa montar uma query a partir de um schema? Use o construtor de queries GraphQL.
Também pesquisado como: formatador graphql, validador graphql, formatar query graphql, graphql prettify, verificador de sintaxe graphql, minificar graphql, validador de schema graphql, formatador sdl.
Ferramentas que combinam com: Formatador e Validador GraphQL
- Formatação JSON — Cole o JSON aqui para formatá-lo, compactá-lo ou validá-lo.
- Validador OpenAPI / Swagger — Cole uma especificação de API para checar contra o schema oficial do OpenAPI, encontrar referências quebradas e parâmetros de path inconsistentes, e ver todos os endpoints de uma vez.
- Validador JSON Schema — Cole um schema e um JSON para ver exatamente quais valores quebram cada regra, ou gere um schema inicial a partir de dados de exemplo.
- Webhook Tester — Gere uma URL única, aponte qualquer webhook ou cliente HTTP para ela e veja as requisições chegarem em tempo real — headers, query string e body formatado, além de verificação de assinatura HMAC.
Perguntas frequentes
Ele suporta arquivos de schema (SDL)?
Ele consegue buscar meu schema de um endpoint?
rover graph introspect, get-graphql-schema ou direto do código do seu servidor.