JSON Schema
Gere JSON Schema automaticamente a partir de um JSON de exemplo. Ideal para validação de APIs.
O que é esta ferramenta?
JSON Schema descreve o formato esperado de um payload JSON: campos obrigatórios, tipos, arrays, objetos aninhados e restrições. Use quando ler o JSON não é suficiente e você precisa documentar um contrato.
Como usar
- Cole uma amostra JSON segura e representativa.
- Gere ou revise a estrutura do schema, conferindo campos obrigatórios e tipos inferidos.
- Use o schema como ponto de partida para validação, mocks, testes de contrato ou documentação.
Exemplo prático
Uma amostra pequena de configurações pode virar um rascunho de schema para evitar regressões.
Amostra:
{ "tema": "escuro", "itensPorPagina": 25, "alertas": true }
Foco do schema:
- tema: string
- itensPorPagina: number
- alertas: booleanAPI
A documentação da API ajuda a conectar schemas com exemplos repetíveis de requests e responses.
Quando usar
Ferramentas relacionadas
Privacidade
Use exemplos reduzidos. Remova e-mails, registros de clientes, tokens e identificadores internos antes de gerar um schema.
Perguntas frequentes
Um JSON Schema gerado está sempre correto?
Não. Ele reflete a amostra informada e precisa de revisão antes de virar teste ou documentação oficial.
JSON Schema valida regra de negócio?
Ele valida estrutura e algumas restrições, mas regras de negócio podem exigir lógica da aplicação.
Posso gerar schema com dados reais?
Prefira uma amostra segura, reduzida ou anonimizada para não expor campos confidenciais.
Limitações / quando não usar
Um schema gerado é um rascunho. Revise campos opcionais, enums, formatos de data e regras de domínio antes de usar como fonte oficial.