Gerador de Esquema JSON

O Gerador de Esquema JSON transforma amostras de JSON em esquemas prontos para validação em APIs, webhooks, arquivos de configuração, pipelines de dados e documentação. Cole um objeto JSON representativo, um array ou feed NDJSON, escolha o estilo de inferência e a ferramenta criará um esquema com propriedades aninhadas, regras de itens de array, valores anuláveis, exemplos e notas detalhadas de caminho por caminho.

Por que usar um Gerador de Esquema JSON baseado em amostras?

Escrever um JSON Schema manualmente é preciso, mas demorado, especialmente quando os dados contêm objetos aninhados, arrays de registros, campos opcionais e valores anuláveis. Este gerador oferece um primeiro rascunho estruturado que captura o formato observado dos seus dados JSON e, em seguida, destaca onde a revisão humana ainda é necessária. É extremamente útil para validação de requisições de API, contratos de resposta, desenvolvimento com OpenAPI, payloads de webhook, fluxos de eventos e esquemas de configuração.

Como usar

1. Cole um objeto JSON representativo, um array JSON ou registros JSON delimitados por quebras de linha no editor de amostras.
2. Selecione o draft do JSON Schema e decida se deseja inferir campos obrigatórios, exemplos, dicas de enum, formatos de string e objetos fechados. Por padrão, o draft é Draft 2020-12, os campos obrigatórios são definidos como Observado em cada objeto, Detectar formatos, Incluir exemplos e Inferir dicas de enum estão ativados, e Objetos fechados está desativado. O título do esquema começa como GeneratedSchema.
3. Clique em Gerar JSON Schema para inferir tipos, propriedades aninhadas, itens de array, campos anuláveis e dicas de validação.
4. Verifique o mapa gerado para ver cada caminho, tipo inferido, status de obrigatório, formato e regra antes de usar o esquema.
5. Copie o esquema gerado e refine as regras de validação específicas do domínio, como intervalos exatos, padrões de ID e enums específicos do negócio.

O que o gerador infere

• Tipos principais do JSON: object, array, string, number, integer, boolean e null.
• Propriedades de objetos aninhados e campos obrigatórios com base no que aparece em cada objeto observado.
• Esquemas de itens de array mesclando os itens observados na amostra.
• Formatos de string comuns incluindo email, URL, data, data-hora, UUID, IPv4 e IPv6.
• Exemplos opcionais, dicas de enum, intervalos numéricos observados e comprimentos de string observados.

FAQ

O que este Gerador de Esquema JSON faz?

Ele lê uma amostra de JSON e cria um JSON Schema que descreve o formato dos dados observados. O gerador infere propriedades de objetos, arrays, tipos primitivos, valores anuláveis, exemplos, dicas de enum, campos obrigatórios e formatos comuns de string.

Um esquema gerado pode ser usado em produção imediatamente?

Use-o como um excelente ponto de partida e, em seguida, revise-o. Os dados de amostra não podem prever todas as regras de negócio, portanto, você ainda pode precisar adicionar padrões, intervalos exatos, valores de enum permitidos, regras de versão e configurações mais rígidas de additionalProperties.

Quais drafts do JSON Schema são suportados?

A ferramenta pode gerar esquemas para Draft 2020-12, Draft 2019-09 e Draft-07 configurando o URI $schema. A estrutura inferida é intencionalmente compatível com os validadores mais comuns.

Como os campos obrigatórios são inferidos?

Quando a inferência de campos obrigatórios está ativada, uma propriedade só é marcada como obrigatória se aparecer em todos os objetos observados naquele nível. Para um array de objetos, isso significa que o campo precisa aparecer em todos os itens amostrados.

A ferramenta suporta arrays de objetos e NDJSON?

Sim. Um array JSON de nível superior é tratado como um esquema de array, e registros JSON delimitados por quebra de linha são tratados como um array de registros. As propriedades dos itens são mescladas a partir das amostras observadas.