Generar JSON Schema

¿Qué es JSON Schema?

JSON Schema es una especificación que utiliza JSON para describir la estructura de otros datos JSON, sus tipos de campos y sus restricciones. Puede utilizarse para validar parámetros de API, comprobar archivos de configuración, validar datos y describir estructuras en documentación de API. Esta herramienta infiere automáticamente la estructura a partir de un JSON existente y genera un JSON Schema inicial.

¿Cómo generar un Schema desde JSON?

Pega los datos JSON en el área de entrada o carga un archivo JSON local, selecciona la versión de Schema Draft y las opciones de campos y pulsa generar. La herramienta identifica tipos JSON como objetos, arrays, cadenas, números, booleanos y null, y genera el Schema según la estructura anidada real.

¿Cuál es la diferencia entre Draft 2020-12 y Draft-07?

Draft 2020-12 y Draft-07 son versiones diferentes de la especificación JSON Schema. Al generar un Schema debes elegir la versión que corresponda al validador, framework o Schema existente de tu proyecto. Si el proyecto no establece una versión concreta, puedes comenzar con Draft 2020-12 y adaptarlo posteriormente al entorno de ejecución.

¿Por qué algunos campos aparecen como required?

Cuando se activa la opción de hacer todos los campos required, la herramienta añade los campos presentes en cada objeto JSON al array required, indicando que deben existir durante la validación. Si la opción está desactivada, los campos no se añaden automáticamente a required. Recuerda que required indica si una propiedad existe, pero no significa que su valor no pueda estar vacío.

¿Qué es additionalProperties?

additionalProperties controla si un objeto puede contener propiedades que no estén definidas en el Schema. Cuando se permiten, el objeto puede incluir campos no enumerados; cuando se prohíben, las propiedades adicionales se consideran incompatibles con el Schema durante la validación. Al generar el Schema puedes elegir según el nivel de control que necesite tu API o estructura de datos.

¿Cómo se generan objetos y arrays anidados?

Para los objetos anidados, la herramienta continúa generando la estructura correspondiente de properties. Para los arrays genera una definición items basada en sus elementos. Los objetos incluidos dentro de arrays también se analizan, incluidos sus campos y niveles anidados, lo que permite crear rápidamente un Schema estructural a partir de un ejemplo JSON real.

¿Por qué el Schema generado es solo una regla inicial?

La generación automática solo puede inferir la estructura a partir del ejemplo proporcionado y no puede determinar con precisión todas las reglas de negocio. Por ejemplo, que un campo sea actualmente numérico no significa que siempre deba estar dentro de un rango concreto; que un campo aparezca en el ejemplo tampoco significa necesariamente que sea obligatorio en todos los casos. Después de generar el Schema, se recomienda añadir según las reglas reales de la aplicación restricciones como formatos, rangos, enumeraciones y descripciones.

¿Cómo generar un Schema desde un archivo JSON local?

Cambia a la pestaña de archivos y arrastra el archivo JSON al área de carga o selecciónalo desde el equipo. El archivo se lee y analiza en el navegador y el resultado se muestra directamente en la página. No es necesario enviar el archivo al servidor. El Schema generado puede copiarse o descargarse para utilizarlo posteriormente en validación de API o configuración de proyectos.

¿Cómo utilizar el Schema generado?

El Schema generado puede guardarse como archivo JSON y utilizarse con un validador compatible con JSON Schema. Al integrarlo en un proyecto, comprueba la versión Draft utilizada y las palabras clave compatibles con el validador correspondiente. Si necesitas comprobar si un JSON concreto cumple el Schema generado, puedes utilizar la herramienta Validación JSON Schema.