Validación del esquema JSON antes de las llamadas a la API

Validación de Esquema JSON antes de Llamadas a API

El Esquema JSON es un contrato que define la estructura, tipos y restricciones de un documento JSON. Valida los payloads antes de enviarlos a una API, y capturas errores en el lado del cliente en lugar de depurar respuestas crípticas 400.

Cómo se ve un Esquema JSON

{
  "$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 esquema obliga a cumplir: email debe ser una cadena de correo electrónico válida, age debe ser un entero entre 0 y 150, role debe ser uno de tres valores, y tanto email como role son requeridos.

Por qué Validar antes de Enviar

Validación en JavaScript (ajv)

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

const ajv = new Ajv();
addFormats(ajv); // agrega "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: 'debe coincidir con el formato "email"'}, ...]
}

Validación en 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' es una propiedad requerida

Consejo de Flujo de Trabajo

Antes de probar cualquier llamada a API, pega tu payload JSON en la herramienta de formato JSON para validar la sintaxis y embellecer la estructura. Una sola coma al final o una clave mal citada fallará silenciosamente en muchos clientes HTTP -- captúralo visualmente primero.

Relacionado