Gerador de Definições de Tipos GraphQL a partir de JSON

Gerador de Definições de Tipos GraphQL a partir de JSON

Cole qualquer objeto ou array JSON e receba instantaneamente um documento de linguagem de definição de esquema do GraphQL (SDL) que descreve sua estrutura. O gerador percorre a árvore JSON, infere tipos escalares, nomeia objetos aninhados, une variantes de array de objetos e emite um tipo raiz opcional Query para que a saída esteja pronta para ser inserida em um servidor como Apollo, Yoga, Mercurius ou graphql-go.

Por que um conversor determinístico de JSON para SDL do GraphQL é importante

Escrever manualmente tipos do GraphQL a partir de um payload de exemplo é mecânico, mas propenso a erros. Uma ausência de nulidade, uma inconsistência Int vs Floatou a esquecimento de um marcador de não nulo em um elemento de lista pode quebrar a geração de código para todos os clientes downstream. Um gerador baseado em regras trata o mesmo exemplo JSON de forma idêntica sempre que é executado, o que torna seguro regenerar a cada alteração na API.

Como usar

1. Cole um objeto ou array JSON no campo de entrada ou clique Tente um exemplo para carregar um payload representativo.
2. Defina o Nome do Tipo Raiz se você quiser algo diferente do Root.
3. Escolha um Nulidade do Campo estratégia – estrita (!) para campos obrigatórios ou todos nulos para prototipagem.
4. Alternar Detecção de ID para promover automaticamente id e *Id chaves para o escalar do GraphQL ID .
5. Opcionalmente inclua um tipo raiz com campos de entidade única e de lista de entidades. Query Copie o SDL ou baixe-o como
6. Infereção de Escalares schema.graphql.

Características

• – distingue de forma determinística. String, Int, Float, Booleane, e ID Tipos de Objetos Aninhados
• – gera um tipo nomeado separado para cada objeto aninhado usando PascalCase a partir da chave do campo. Unificação de Arrays de Objetos
• – une todas as propriedades entre os itens do array para que campos opcionais sejam corretamente marcados. Alternância entre Nulo e Não Nulo
• – emite marcadores estritos ou relaxa tudo para nulo para protótipos iniciais. ! Detecção Automática de ID
• – promove chaves no estilo para o id, userId, orderId esqueleto de consulta raiz ID .
• – opcional com assinaturas de resolvers para entidades únicas e listas. – seu JSON nunca sai do navegador, então a ferramenta é segura para payloads sensíveis. type Query { ... } Regras de Infereção de Tipos
• Exclusivamente do lado do cliente Números inteiros mapeiam para

; números com parte fracionária mapeiam para

• . Um campo visto como ambos promove para IntStrings mapeiam para Float. Com detecção de ID ativada, chaves nomeadas Float.
• ou terminando em Stringtornam-se id Valores booleanos mapeiam para Id os campos que têm valores nulos indicam que o campo é nulo, para que o SDL gerado pule a parte final ID.
• Arrays vazios default para Boolean.
• null porque não é possível inferir um tipo de elemento de forma segura. !.
• Arrays de objetos se unem em um tipo nomeado; campos ausentes em qualquer elemento tornam-se automaticamente nulos. [String] Quem o utiliza
• Engenheiros de backend que envolvem um endpoint REST ou um arquivo JSON em uma gateway do GraphQL.

Desenvolvedores de frontend que prototipam um esquema contra um payload de exemplo antes que a API esteja pronta.

• Designers de API que documentam as formas de resposta de terceiros como um contrato tipado.
• Pipeline de geração de código que precisa de um artefato reprodutível de SDL a partir de um exemplo JSON estável.
• O que é o SDL do GraphQL?
• A Linguagem de Definição de Esquema é a sintaxe baseada em texto do GraphQL para descrever tipos, campos, consultas e mutações expostas por uma API. Usa palavras-chave como type, scalar, enum e input para declarar a estrutura dos dados que um servidor pode retornar e as operações que um cliente pode chamar.