Formatador / Validador GraphQL
Cole uma query, mutation, fragment ou schema SDL de GraphQL para formatar, validar, minificar e inspecionar a estrutura.
O que é um formatador / validador GraphQL?
Um formatador / validador GraphQL formata queries, mutations, subscriptions, fragments e schema SDL de GraphQL em um estilo consistente e legível.
Ele ajuda desenvolvedores a revisar documentos GraphQL, detectar erros de sintaxe cedo, minificar requisições e verificar a estrutura básica como operações, fragments, tipos de schema e profundidade de seleção.
Como usar o formatador / validador GraphQL
- Cole uma query, mutation, fragment ou definição de schema GraphQL no editor.
- Clique em Formatar para imprimir o documento com indentação consistente.
- Clique em Validar para verificar a sintaxe sem alterar a saída.
- Revise operações, fragments, tipos, profundidade e notas de validação.
Dicas
- Use Formatar antes de uma revisão de código para tornar queries GraphQL mais fáceis de ler.
- Use Minificar ao incorporar uma query em um payload compacto.
- Profundidade de seleção alta pode tornar resolvers GraphQL mais caros.
- Esta ferramenta valida a sintaxe localmente no navegador; ela não valida campos contra um schema remoto.
Guias relacionados
Entenda o workflow por trás desta ferramenta e o que revisar depois.
Verificações de GraphQL antes de compartilhar ou executar uma operação
A formatação melhora a leitura, mas a correção depende do esquema, variáveis, fragmentos e regras de autorização do servidor.
Identidade da operação
Nomeie queries e mutations claramente para que traces, operações persistidas, logs e erros identifiquem a mesma requisição.
Variáveis
Mova valores variáveis para parâmetros tipados e verifique obrigatoriedade, listas, nullability e valores padrão.
Fragmentos e campos
Remova fragmentos sem uso e seleções duplicadas, mas mantenha identificadores e campos de paginação necessários.
Remoção de segredos
Não inclua bearer tokens, cookies, dados de clientes ou variáveis de produção ao compartilhar uma operação para diagnóstico.
Ferramentas relacionadas
Você também pode achar essas ferramentas úteis.