Gerador de esquema de JSON
Gere um esquema de JSON a partir de uma amostra de JSON. O gerador infere tipos, propriedades obrigatórias, esquemas de itens de array e formatos de string comuns, como data e hora, e-mail, uri e uuid, e cria um esquema para o rascunho 2020-12, 2019-09 ou draft-07, que você pode usar para validar solicitações, documentar uma API ou gerar formulários.
Perguntas frequentes
Quais rascunhos do Schema de JSON são compatíveis?
Draft 2020-12, a versão atual usada pelo OpenAPI 3.1, draft 2019-09 e draft-07, ainda esperados por muitos validadores e ferramentas mais antigos. A escolha define o $schema URL; as palavras-chave geradas significam o mesmo nos três.
Como as propriedades obrigatórias são definidas?
Uma propriedade é listada em required quando aparece em todas as amostras daquele objeto. Em um array de objetos, uma chave ausente em alguns itens não é incluída em required. Desative a opção para gerar um esquema sem listas de required.
Quais formatos de string são detectados?
date-time, date, time, email, uri, uuid e ipv4. Um formato só é adicionado quando todos os valores de amostra daquela propriedade correspondem a ele; assim, um valor de texto livre mantém a propriedade como uma string simples. Desative a detecção se não quiser palavras-chave de formato.
O esquema diferencia inteiros de decimais?
Sim. Uma propriedade cujas amostras são todas números inteiros recebe o tipo integer. Se uma amostra tiver uma parte fracionária, o tipo passa a ser number, que também aceita inteiros.
Como os arrays são descritos?
Um array recebe o tipo array e um esquema items criado a partir de todos os seus elementos em conjunto. Objetos em um array são combinados, então o esquema items lista todas as chaves presentes em qualquer elemento, e required inclui apenas as chaves presentes em todos eles.
O que acontece com tipos mistos?
Quando uma propriedade contém valores simples de tipos diferentes, como uma string em um item e null em outro, o esquema os lista como um array de tipos, por exemplo, ["string", "null"]. Quando objetos ou arrays são combinados com outros tipos, o gerador usa anyOf com um esquema para cada tipo.
Ele adiciona additionalProperties ou limites?
Não. Uma amostra não mostra quais chaves extras são proibidas nem quais são os valores mínimo e máximo reais, então o gerador omite additionalProperties, minLength, maximum e palavras-chave semelhantes. Adicione-as manualmente quando seus dados precisarem delas.
Posso validar dados com o resultado?
Sim. Cole o esquema e seus dados no Validador de Esquema de JSON ou use-os com uma biblioteca como Ajv. Confira o esquema primeiro: ele reflete sua amostra, então um campo que pode estar ausente ou ser null nos dados reais, mas não na amostra, precisa de um pequeno ajuste.
Posso usar o esquema no OpenAPI?
O OpenAPI 3.1 usa o JSON Schema 2020-12 diretamente, então o esquema gerado pode ser colocado em components/schemas depois que você remover a linha $schema. O OpenAPI 3.0 usa um subconjunto mais antigo; nesse caso, substitua os arrays de tipo por nullable.
Qual pode ser o tamanho da entrada?
Até 1,000,000 caracteres de JSON, aninhado em até 64 níveis. O exemplo é analisado apenas para esta solicitação e não é armazenado.