Entrada JSON

Esquema gerado

O que é um gerador de esquema JSON?

JSON Schema descreve a estrutura dos dados JSON: campos obrigatórios, tipos, valores permitidos, formatos. Um gerador de esquema infere um esquema a partir de JSON de exemplo. Você cola dados de exemplo e ele produz um esquema que descreve essa estrutura. Você pode então usar o esquema para validar outro JSON ou documentar APIs.

Esta ferramenta roda no seu navegador. Cole seu JSON e ela gera um rascunho de JSON Schema. Nada é enviado a um servidor.

Como usar esta ferramenta

1

Colar JSON de exemplo

Cole JSON que representa a estrutura que deseja descrever. Use Amostra ou Enviar se necessário. O gerador infere tipos a partir dos valores (string, number, boolean, array, object).

2

Revisar o esquema

O painel direito mostra o esquema gerado. Pode incluir type, properties, required e esquemas aninhados para objetos. Você pode editá-lo manualmente se necessário.

3

Copiar ou baixar

Use <strong>Copiar</strong> ou <strong>Baixar</strong> para obter o esquema. Para validar JSON contra um esquema, use o Validador JSON ou uma biblioteca como <a href="https://ajv.js.org/" target="_blank" rel="noopener">Ajv</a>.

Exemplos de JSON Schema

Gerar um esquema a partir de JSON de exemplo. Exemplo de telecomunicações:

Entrada JSON

Entrada

Esquema gerado

Saída

Quando usar um esquema gerado

Esquemas gerados são um ponto de partida. Eles capturam a estrutura dos seus dados de exemplo, mas podem ser muito rígidos ou muito flexíveis. Você pode precisar adicionar arrays required, ajustar tipos ou adicionar enum para valores permitidos. A documentação JSON Schema explica o vocabulário completo. Para documentação de API, ferramentas como OpenAPI podem referenciar JSON Schema.

Perguntas frequentes

Posso validar JSON com este esquema?

Esta ferramenta apenas gera esquemas. Para validar, use o Validador JSON ou uma biblioteca como <a href="https://ajv.js.org/" target="_blank" rel="noopener">Ajv</a> no seu código.

E se meu JSON tiver formas diferentes?

O gerador infere a partir do exemplo que você fornece. Se seu JSON pode ter múltiplas formas (ex. campos opcionais), o esquema pode precisar de edições manuais. Use oneOf ou anyOf para variantes.

Meus dados são enviados para algum lugar?

Não. A geração ocorre no seu navegador.

Qual rascunho de JSON Schema é usado?

A ferramenta pode usar draft-07 ou draft-2020-12. Verifique o esquema gerado para $schema para ver a versão. A especificação JSON Schema tem os detalhes.

Posso usar isso para respostas de API?

Sim. Cole uma resposta típica de API. O esquema gerado descreve essa estrutura. Você pode então usá-lo em OpenAPI/Swagger ou para documentação.

Ferramentas relacionadas

Saiba mais em json-schema.org e JSON Schema learn. Para validação em código, consulte Ajv. Para JSON, consulte json.org, MDN e RFC 8259. Para documentação de API, consulte OpenAPI.