Gerador de JSON Schema
Gere um JSON Schema a partir de dados JSON de exemplo, identificando os tipos, objetos aninhados, arrays e propriedades obrigatórias. Pronto para copiar ou baixar. Funciona no seu navegador.
Entrada
Saída
Leia-me
O que o Gerador de JSON Schema faz?
Ele cria um JSON Schema para você com base em um exemplo dos seus dados. Cole uma amostra, como uma resposta de API, um arquivo de configuração ou um registro de uma exportação de banco de dados, e você obtém um esquema que descreve sua estrutura: o tipo de cada valor, as propriedades de cada objeto, como são os itens de cada matriz e quais propriedades são obrigatórias. É um ponto de partida rápido para documentação de API, especificações OpenAPI, validação de formulários ou contratos de dados, que você pode depois ajustar manualmente.
Como usar
- Cole ou digite um JSON de exemplo na caixa de entrada.
- Escolha a versão do JSON Schema para a linha
$schema: Draft 2020-12 ou Draft 7. - Escolha se as propriedades devem ser marcadas como obrigatórias.
- Copie o esquema ou baixe-o como
schema.json.
Se a amostra não for um JSON válido, a ferramenta informa a linha e a coluna do problema e o destaca.
Como o esquema é determinado
- Cada valor recebe seu tipo JSON:
string,boolean,null,object,arrayeintegerpara números inteiros ounumberpara números decimais. Uma matriz com números inteiros e decimais recebe o tiponumber, que abrange ambos. - Para cada chave, os objetos recebem uma entrada em
properties, descrita da mesma maneira, até o nível mais profundo presente na amostra. - As matrizes recebem um único esquema
itemsque se aplica a todos os itens. Quando os itens são objetos, suas propriedades são combinadas; assim, uma lista de registros gera um esquema para um registro. - Valores de tipos diferentes recebem todos os tipos em uma lista, como
["string", "null"], ou umanyOfquando há objetos misturados com outros valores. - Uma matriz vazia recebe
"type": "array"semitems, pois não há nada a descrever.
Propriedades obrigatórias
Com a opção “Marcar propriedades como obrigatórias” ativada, cada objeto lista suas chaves em required. Para uma matriz de objetos, uma propriedade só é obrigatória quando está presente em todos os itens: em uma lista de membros na qual apenas alguns têm favorite, essa propriedade é opcional. Desative a opção para obter um esquema sem listas required.
O que uma amostra não pode informar
Um esquema criado a partir de um único exemplo só conhece o que esse exemplo mostra. Ele não pode saber quais valores de texto são e-mails ou datas, quais intervalos os números podem abranger nem se uma propriedade observada uma vez também pode estar ausente. Adicione format, minimum, maxLength, enum ou pattern manualmente quando necessário e valide os dados com o JSON Schema Validator.
Como funciona
A ferramenta usa o genson-js, uma adaptação de GenSON para JavaScript que cria esquemas. As palavras-chave que ela gera têm o mesmo significado em Draft 7 e Draft 2020-12, então a versão escolhida só altera a linha $schema. Tudo é executado no seu navegador: a amostra nunca é enviada.
Recursos
- JSON Schema a partir de qualquer amostra JSON
- Tipos, objetos aninhados e matrizes determinados automaticamente
- Itens de matrizes combinados em um único esquema, com propriedades opcionais identificadas
- Draft 2020-12 ou Draft 7
- Propriedades obrigatórias ativadas ou desativadas
- Copie ou baixe como
schema.json - Executado no seu navegador