Como Usar JSON Schema para Validar Seus Dados
O que é um JSON Schema?
JSON Schema é uma forma padronizada de descrever a estrutura, os campos obrigatórios e os tipos de valor dos seus dados JSON. Pense nele como um contrato ou modelo que define como um JSON válido deve ser. JSON Schema é escrito em JSON, o que o torna legível por máquinas e fácil de editar.
Por que Validar com um Schema?
- Evite bugs ao detectar dados inválidos ou faltantes antes que causem problemas.
- Mantenha consistência dos dados entre diferentes equipes, aplicações ou APIs.
- Gere documentação automaticamente a partir dos schemas.
- Auxilie editores e ferramentas a fornecer melhor auto-completação e ajuda contextual.
Um Exemplo Simples: Schema Básico
Veja um objeto JSON básico, seguido de um schema mínimo que valida sua estrutura:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Este schema assegura que o objeto deve ter um 'name' (como string) e uma 'age' (como número).
Como Escrever um Schema Personalizado
Você pode definir regras avançadas no seu schema: restringir valores de campos, definir objetos aninhados ou estabelecer mínimos/máximos para números. Aqui está um exemplo que valida um array de produtos:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Como Usar o JSONValidator.dev para Validação de Schema
- Cole seus dados JSON no editor principal.
- Cole seu JSON Schema no editor de schema abaixo.
- Clique em Validar JSON Contra Este Schema.
- Confira os resultados da validação, com erros destacados e explicados.
Resolvendo Erros na Validação de Schema
As causas mais comuns para erros de validação são:
- Falta algum campo obrigatório nos seus dados.
- O tipo de valor não corresponde ao definido no schema (ex.: string vs. número).
- O próprio schema está inválido ou contém erros de digitação.
Conclusão
A validação com JSON Schema é uma forma poderosa de tornar seus dados mais robustos e livres de erros. Experimente criar um schema para seus próprios dados com nosso gerador gratuito JSON Schema Generator e valide ao vivo!