Formatador de GraphQL
Formate consultas, mutações, fragmentos e esquemas GraphQL com este formatador de GraphQL. Cole um documento e a ferramenta o analisa com um analisador de GraphQL e o exibe em um formato padrão: indentação de dois espaços, um campo por linha, remoção de vírgulas entre campos e espaçamento consistente para argumentos e variáveis. Erros de sintaxe são informados para que desenvolvedores de API tenham operações e SDL legíveis para documentação, revisões e depuração.
Perguntas frequentes
Como funciona o Formatador de GraphQL?
Ele analisa seu documento e o transforma em uma árvore sintática de GraphQL, depois o imprime em um formato padrão. Como o documento é analisado, GraphQL inválido é rejeitado em vez de ser reformatado incorretamente.
O que posso formatar?
Consultas, mutações, assinaturas e fragmentos, além de definições de esquema em SDL, como blocos de tipo, entrada, enumeração, interface, união e esquema. Você pode combinar várias definições em um único documento.
Como é a saída?
Cada conjunto de seleções é recuado em dois espaços, com um campo por linha, e as vírgulas entre os campos são removidas. Argumentos e definições de variáveis recebem um espaço após cada dois-pontos, por exemplo user(id: $id).
O que acontece quando há um erro de sintaxe?
A ferramenta para e exibe a mensagem do analisador, como Syntax Error: Expected Name, found }. Corrija o trecho indicado e formate novamente.
Os comentários são preservados?
O formatador mantém os comentários com cerquilha (#) onde o analisador pode associá-los, como após uma chave de fechamento. As descrições entre aspas nos tipos e campos do esquema fazem parte do documento e são sempre preservadas.
Ele valida minha consulta em relação a um esquema?
Não, ele verifica apenas a sintaxe. A existência de campos e argumentos é determinada pelo esquema do seu servidor, então use seu cliente ou servidor GraphQL para validar.
Posso formatar uma string de consulta copiada do JavaScript?
Cole apenas o documento GraphQL, sem aspas, crases ou uma tag gql ao redor. Os caracteres escapados de um payload JSON devem ser desescapados primeiro.
Posso mudar a indentação?
Não, o formatador sempre usa dois espaços e não tem opções. Esse formato corresponde ao usado pela maioria das ferramentas e documentações de GraphQL.
Por que o resultado vem dentro de um bloco de código graphql?
A saída é retornada como um bloco de código Markdown identificado como graphql, para ser exibida com realce de sintaxe no Markdown. Copie as linhas entre as cercas para um arquivo .graphql.
Qual pode ser o tamanho do meu documento?
Até 5 MB por execução; entradas maiores são rejeitadas com uma mensagem. A saída é idêntica à opção GraphQL do Code Formatter.