Cómo validar datos JSON con un esquema JSON Schema

Qué puedes comprobar con el validador JSON Schema

El validador JSON Schema sirve para comprobar si unos datos JSON cumplen las reglas definidas en un esquema JSON. Introduce el texto de los datos en un campo y el texto del esquema en otro para obtener un resultado de validez junto con los detalles aplicables. Es útil antes de enviar una carga de datos a una API, revisar una configuración o detectar cambios incompatibles en una estructura JSON.

Cómo validar datos JSON paso a paso

1. Prepara dos textos JSON. En el primer campo, pega el objeto o array que quieres revisar. En el segundo, pega el documento JSON Schema que describe su estructura. Los dos campos son opcionales, pero la operación necesita contenido en ambos para validar los datos.

2. Comprueba que los dos textos tengan sintaxis JSON válida. Puedes definir tipos como string, number, integer, boolean, object y array. En objetos, añade propiedades requeridas cuando deban estar presentes. Si el esquema desactiva las propiedades adicionales, también puede rechazar propiedades que no estén declaradas.

3. Añade las reglas que necesites y que admita esta validación: valores permitidos mediante enum, límites numéricos, longitudes mínima y máxima de cadenas y reglas para los elementos de una matriz. Las comprobaciones se aplican también a valores anidados según la estructura del esquema.

4. Ejecuta la validación y revisa el informe. Si falta uno de los textos o contiene solo espacios, el resultado indica que los datos no son válidos y señala el JSON o el esquema que falta. Si uno de los textos no se puede interpretar como JSON, recibirás un resultado no válido con una descripción del error de análisis.

5. Cuando ambos textos se pueden analizar, compara los detalles con la regla que querías revisar. Corrige los datos o el esquema y vuelve a ejecutar la operación para comprobar el cambio.

Cómo leer el resultado y conocer sus límites

La validez de los datos y el estado de la operación son conceptos separados. La operación puede comunicar un estado satisfactorio tanto cuando los datos son válidos como cuando faltan entradas, hay un error de análisis o los datos incumplen una regla; por eso debes leer el indicador de validez y sus detalles, no solo el estado general.

Un informe no válido puede señalar un tipo incorrecto, una propiedad requerida ausente, una propiedad no declarada cuando no se permiten adicionales, un elemento de matriz que no cumple su esquema o un valor fuera de los límites definidos. Si usas una colección de esquemas para describir los elementos de una matriz, revisa su forma: una colección no objeto vacía puede generar un error porque no existe un primer esquema que aplicar.

Ejemplo: quieres aceptar { "edad": 25 } y defines una propiedad edad de tipo entero con un mínimo de 0. Al enviar ambos textos, el resultado puede indicar que los datos son válidos. Si cambias el valor a -1, el resultado pasa a no válido por incumplir el mínimo. El informe conserva la distinción entre esa validez y el estado satisfactorio de la operación.

Usa el resultado como una comprobación basada en las reglas que admite esta herramienta. No lo interpretes como cobertura de todas las capacidades de JSON Schema: las comprobaciones revisadas no establecen compatibilidad con referencias, composición, formatos ni reglas de patrones. Cuando necesites una de esas funciones, verifica primero si está contemplada por tu flujo de trabajo.

Ejemplo práctico

Una persona quiere comprobar que la edad de un registro no sea negativa antes de procesar ese registro.

Introduce los datos { "edad": 25 } y un esquema que declare edad como entero con mínimo 0. Después sustituye 25 por -1 y ejecuta de nuevo la comprobación.

El informe muestra una validez positiva para el valor 25 y una validez negativa con un detalle de mínimo incumplido para el valor -1; el estado general de la operación se comunica por separado.

Limitaciones

• La herramienta aplica las comprobaciones implementadas para el esquema proporcionado; estas comprobaciones no demuestran compatibilidad con referencias, composición, formatos ni reglas de patrones.

Errores frecuentes

• Un error frecuente es pegar comillas, comentarios o una coma final que no forman parte de la sintaxis JSON. La corrección consiste en revisar y analizar por separado los datos y el esquema antes de volver a validar.

Preguntas frecuentes

¿Qué ocurre si dejo vacío el campo de datos o el del esquema?

Si uno de los campos está vacío o contiene solo espacios, el resultado indica que los datos no son válidos y señala si falta el JSON o el esquema.

¿Cómo se informa un JSON mal escrito?

Si el texto no se puede analizar como JSON, la operación devuelve un resultado no válido con una descripción del error de análisis.

¿Qué reglas puede comprobar?

El resultado puede señalar tipos, propiedades requeridas, propiedades adicionales, elementos de matrices, enumeraciones, límites numéricos o longitudes de cadenas, siempre que esas reglas estén presentes en el esquema.