Saltar al contenido

Generador de esquemas JSON

Genera un esquema JSON a partir de un ejemplo de JSON. El generador infiere los tipos, las propiedades obligatorias, los esquemas de elementos de arrays y formatos de cadena comunes como date-time, email, uri y uuid; y escribe un esquema para el borrador 2020-12, 2019-09 o el borrador-07, que puedes usar para validar solicitudes, documentar una API o generar formularios.

Restablecer

Preguntas frecuentes

¿Qué borradores de esquema JSON se admiten?

El borrador 2020-12, la versión actual que usa OpenAPI 3.1; el borrador 2019-09 y el borrador-07, que muchos validadores y herramientas antiguos aún requieren. La opción determina el $schema URL; las palabras clave que genera la herramienta significan lo mismo en los tres.

¿Cómo se determinan las propiedades obligatorias?

Una propiedad se incluye en required cuando aparece en todas las muestras de ese objeto. En un array de objetos, las claves que faltan en algunos elementos se excluyen de required. Desactiva la opción para generar un esquema sin listas de propiedades obligatorias.

¿Qué formatos de cadena se detectan?

date-time, date, time, email, uri, uuid e ipv4. Solo se añade un formato cuando todos los valores de ejemplo de esa propiedad coinciden con él; por eso, un solo valor de texto libre mantiene la propiedad como una cadena simple. Desactiva la detección si no quieres palabras clave de formato.

¿El esquema distingue los enteros de los decimales?

Sí. Una propiedad cuyas muestras son todas números enteros recibe el tipo integer. En cuanto una muestra tiene una parte fraccionaria, el tipo pasa a ser number, que también acepta enteros.

¿Cómo se describen los arrays?

Un array recibe el tipo array y un esquema items construido a partir de todos sus elementos en conjunto. Los objetos de un array se combinan, así que el esquema items enumera todas las claves presentes en cualquiera de los elementos, y required solo incluye las que aparecen en todos.

¿Qué ocurre con los tipos mixtos?

Cuando una propiedad contiene valores simples de distintos tipos, como una cadena en un elemento y null en otro, el esquema los enumera como un array de tipos; por ejemplo, ["string", "null"]. Cuando se combinan objetos o arrays con otros tipos, el generador usa anyOf con un esquema para cada uno.

¿Añade additionalProperties o límites?

No. Un ejemplo no permite saber qué claves adicionales están prohibidas ni cuáles son los mínimos y máximos reales, así que el generador omite additionalProperties, minLength, maximum y palabras clave similares. Añádelas manualmente según lo requieran tus datos.

¿Puedo validar datos con el resultado?

Sí. Pega el esquema y tus datos en el validador de esquemas JSON o úsalo con una biblioteca como Ajv. Revisa primero el esquema: refleja tu ejemplo, así que tendrás que editarlo si un campo puede faltar o ser null en los datos reales, pero no en el ejemplo.

¿Puedo usar el esquema en OpenAPI?

OpenAPI 3.1 usa directamente el JSON Schema 2020-12, así que el esquema generado puede ir en components/schemas después de quitar la línea $schema. OpenAPI 3.0 usa un subconjunto más antiguo; en ese caso, sustituya los arreglos de tipos por nullable.

¿Qué tamaño puede tener la entrada?

Hasta 1,000,000 caracteres de JSON, con un máximo de 64 niveles de anidación. La muestra se analiza solo para esta solicitud y no se almacena.

Acerca de OneClick Pro

OneClick Pro es una colección gratuita de más de 150 herramientas web para las tareas cotidianas: convertir imágenes y unidades, dar formato y validar código, consultar dominios y SEO, y trabajar con texto, fechas y números. Todas las herramientas funcionan sin registro ni suscripción; los datos que introduce solo se utilizan para calcular el resultado y nunca se almacenan. Úsela como una caja de herramientas para tareas puntuales o añada a favoritos las que utiliza a diario.