Exemplo prático
Valide {"age":"18"} contra um esquema que exige um inteiro. O JSON é sintaticamente válido, mas a string ainda viola o contrato da API.
type, required, properties, itemsenum, minLength, minimumadditionalProperties: falsetype: ["string", "null"]Um validador/gerador de esquema JSON ajuda a criar um esquema JSON a partir de um JSON de amostra e validar dados JSON em um esquema existente.
Isso é útil para contratos de API, validação de back-end, teste de respostas estruturadas e documentação de formatos de carga útil esperados.
Marque campos como required apenas quando todo payload válido deve incluí-los. Optional funciona melhor para rollouts graduais e respostas parciais.
Use additionalProperties false quando campos inesperados devem falhar, mas evite se clientes podem enviar metadata compatível no futuro.
Represente nullables explicitamente com arrays de tipo como ["string", "null"] para não confundir null com campo ausente.
Adicione enum, minimum, minLength e constraints semelhantes depois da geração para aproximar o schema do contrato real.
Você também pode editar o esquema gerado manualmente. Esta versão oferece suporte a regras comuns, como tipo, obrigatório, enum, minLength, mínimo, tipos anuláveis, itens de matriz e propriedades adicionais.
{
"type": "object",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"minLength": 2
},
"age": {
"type": "integer",
"minimum": 18
},
"status": {
"type": "string",
"enum": ["active", "disabled"]
},
"nickname": {
"type": ["string", "null"]
}
},
"additionalProperties": false
}
Entenda o workflow por trás desta ferramenta e o que revisar depois.
Um processo de criação de esquemas que transforma dados válidos e inválidos em documentação executável em vez de depender de um único exemplo ideal.
Um processo repetível para separar erros de transporte, problemas de sintaxe JSON e falhas do contrato de dados nas respostas de uma API.
Um workflow prático para formatar JSON, encontrar erros de sintaxe, validar o formato do payload e revisar o status quando dados de API parecem errados.
A validação deixa explícitas as suposições do contrato antes que virem bugs ou falhas de integração.
Confirme quais campos devem existir, quais podem faltar e quais podem ser null.
Revise arrays, objetos, números, enums, datas e formatos de string contra a forma esperada.
Compare respostas de exemplo após mudanças de API, fornecedor ou versão de webhook.
Use caminhos de validação para encontrar a propriedade exata que falhou.
Valide {"age":"18"} contra um esquema que exige um inteiro. O JSON é sintaticamente válido, mas a string ainda viola o contrato da API.
oneOf, anyOf, campos nullable e additionalProperties podem produzir resultados surpreendentes quando esquemas sobrepostos aceitam o mesmo valor.
Guardo payloads reprovados representativos ao lado do esquema, porque os casos de erro expõem a ambiguidade do contrato mais rápido que uma amostra perfeita.
Você também pode achar essas ferramentas úteis.