Validador de JSON Schema
Valida JSON con un JSON Schema y muestra cada error junto con la ruta del valor que no cumple y la regla que infringe, incluidos formatos como correo electrónico y fecha y hora. Se ejecuta en tu navegador.
Entrada
Salida
Leerme
¿Qué es un esquema JSON?
Un esquema JSON describe cómo debería ser un documento JSON: qué propiedades tiene un objeto, cuáles son obligatorias, el tipo de cada valor, los rangos y las longitudes permitidos, y los patrones y formatos, como direcciones de correo electrónico o fechas. Las API, los archivos de configuración y los creadores de formularios usan esquemas para comprobar los datos antes de confiar en ellos, y OpenAPI los usa para describir los cuerpos de las solicitudes y las respuestas.
Cómo usar el validador
- Pegue o escriba el esquema JSON en el primer cuadro.
- Pegue o escriba los datos JSON que desea comprobar en el segundo cuadro.
- El resultado aparece mientras escribe: el JSON es válido o se muestra una lista de todos los errores, con la ruta del valor que no cumple, la palabra clave del esquema que infringe y una breve explicación.
- Cada valor que no cumple se marca en los datos. Haga clic en un error para desplazarse hasta ese valor en los datos, o haga clic en una marca para encontrar el error correspondiente en la lista.
El campo Versión del esquema indica con qué borrador de JSON Schema se comprobaron los datos.
Borradores compatibles
La palabra clave $schema del esquema determina el borrador:
- Borrador 2020-12:
https://json-schema.org/draft/2020-12/schema - Borrador 2019-09:
https://json-schema.org/draft/2019-09/schema - Borrador 7:
http://json-schema.org/draft-07/schema# - Borrador 6:
http://json-schema.org/draft-06/schema#
Si el esquema no incluye $schema, se comprueba como borrador 7. No se admiten el borrador 4 ni los anteriores. Primero, el esquema se comprueba con el metaesquema de su borrador; por eso, un error tipográfico como "type": "strin" se señala como un esquema no válido, en lugar de ignorarse. Las anotaciones como title, description y examples son válidas, al igual que las palabras clave que el borrador desconoce, como sus propias anotaciones x-: se ignoran.
Cómo interpretar los errores
- Las rutas se escriben en JSONPath y comienzan por
$, que representa el documento completo:$.ingredients[1].unitindica la propiedadunitdel segundo ingrediente. - Si falta una propiedad obligatoria, el error se señala en el objeto que debería contenerla y el mensaje incluye el nombre de la propiedad.
- Si hay una propiedad adicional que el esquema no permite, el error señala el nombre de esa propiedad.
- Para
enumyconst, el mensaje enumera los valores permitidos. - Con
anyOfyoneOf, cada alternativa que no cumple añade sus propios errores, seguidos de otro error para la palabra clave en sí. Por eso, un mismo valor incorrecto puede generar varios errores.
Los mensajes de error proceden de la biblioteca Ajv y están en inglés.
Formatos
También se comprueban los valores con un format: email, uri, uri-reference, date, time, date-time, duration, uuid, ipv4, ipv6, hostname, regex, json-pointer, entre otros. Si el validador no reconoce un formato, lo ignora, tal como permite la especificación de JSON Schema.
Referencias
$ref funciona con definiciones dentro del mismo esquema, como #/$defs/address o #/definitions/address. No se obtienen referencias a otros archivos ni a URL: si un esquema necesita una, se indica que no es válido y se incluye la referencia que no se pudo resolver.
Cómo funciona
La herramienta valida los datos con Ajv, un validador de JSON Schema muy utilizado, y comprueba los formatos con ajv-formats. Todo se ejecuta en el navegador: el esquema y los datos nunca se cargan en un servidor.
Funciones
- Compatibilidad con los borradores 6, 7, 2019-09 y 2020-12 de JSON Schema, según
$schema - Todos los errores, con su ruta, palabra clave y mensaje
- Valores que no cumplen marcados en los datos; haga clic para desplazarse hasta ellos
- Comprobación de formatos para correos electrónicos, URI, fechas, UUID, direcciones IP y más
- Comprobación del esquema con su metaesquema
- Línea y columna de los errores de sintaxis JSON
- Se ejecuta en el navegador