Cómo Usar JSON Schema para Validar Tus Datos
¿Qué es un JSON Schema?
Un JSON Schema es una forma estandarizada de describir la estructura, campos obligatorios y tipos de valor en tus datos JSON. Piensa en él como un contrato o plano que define cómo debe lucir un JSON válido. JSON Schema está escrito en JSON, lo que lo hace legible por máquinas y fácil de editar.
¿Por Qué Validar con un Esquema?
- Evitar errores detectando datos inválidos o faltantes antes de que causen problemas.
- Garantizar la consistencia de datos entre diferentes equipos, aplicaciones o APIs.
- Generar documentación automáticamente a partir de los esquemas.
- Ayudar a editores y herramientas a ofrecer mejor autocompletado y ayuda en línea.
Ejemplo Simple: Esquema Básico
Aquí tienes un objeto JSON básico, seguido de un esquema mínimo que valida su estructura:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Este esquema asegura que el objeto debe tener un 'name' (como cadena) y un 'age' (como número).
Cómo Escribir un Esquema Personalizado
Puedes definir reglas avanzadas en tu esquema: restringir valores, definir objetos anidados o establecer mínimos y máximos. Aquí un ejemplo que valida un array de productos:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Usando JSONValidator.dev para Validar Esquemas
- Pega tus datos JSON en el editor principal.
- Pega tu JSON Schema en el editor de esquemas abajo.
- Haz clic en Validar JSON Contra Este Esquema.
- Revisa los resultados de validación, con errores resaltados y explicados.
Solución de Problemas en Errores de Validación
Las causas comunes de errores de validación incluyen:
- Falta un campo obligatorio en tus datos.
- El tipo de valor no concuerda con el esquema (por ejemplo, cadena vs. número).
- El esquema mismo es inválido o tiene errores tipográficos.
Conclusión
La validación con JSON Schema es una forma poderosa de hacer tus datos robustos y libres de errores. ¡Prueba crear un esquema para tus propios datos con nuestro generador gratuito Generador de JSON Schema y valídalo en vivo!