Validação do esquema JSON antes das chamadas de API

Validação de Schema JSON Antes de Chamadas de API

JSON Schema é um contrato que define a estrutura, tipos e restrições de um documento JSON. Valide os payloads antes de enviá-los para uma API, e você captura erros no lado do cliente em vez de depurar respostas 400 enigmáticas.

Como um JSON Schema Se Parece

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email"
    },
    "age": {
      "type": "integer",
      "minimum": 0,
      "maximum": 150
    },
    "role": {
      "type": "string",
      "enum": ["admin", "user", "viewer"]
    }
  },
  "required": ["email", "role"]
}

Este schema impõe: email deve ser uma string de email válida, age deve ser um inteiro de 0-150, role deve ser um de três valores, e tanto email quanto role são obrigatórios.

Por Que Validar Antes de Enviar

Validação em JavaScript (ajv)

import Ajv from 'ajv';
import addFormats from 'ajv-formats';

const ajv = new Ajv();
addFormats(ajv); // adiciona "email", "uri", "date-time", etc.

const schema = {
  type: 'object',
  properties: {
    email: { type: 'string', format: 'email' },
    role:  { type: 'string', enum: ['admin', 'user', 'viewer'] }
  },
  required: ['email', 'role']
};

const validate = ajv.compile(schema);

const payload = { email: 'not-an-email', role: 'superadmin' };
if (!validate(payload)) {
  console.error(validate.errors);
  // [{keyword: 'format', message: 'must match format "email"'}, ...]
}

Validação em Python (jsonschema)

from jsonschema import validate, ValidationError

schema = {
    "type": "object",
    "properties": {
        "email": {"type": "string", "format": "email"},
        "role":  {"type": "string", "enum": ["admin", "user", "viewer"]}
    },
    "required": ["email", "role"]
}

try:
    validate(instance={"email": "[email protected]"}, schema=schema)
except ValidationError as e:
    print(e.message)  # 'role' is a required property

Dica de Workflow

Antes de testar qualquer chamada de API, cole seu payload JSON no JSON Formatter para validar a sintaxe e embelezar a estrutura. Uma única vírgula à direita ou chave entre aspas incorretas falhará silenciosamente em muitos clientes HTTP -- detecte-o visualmente primeiro.

Relacionado