Generador de Esquemas JSON

El Generador de Esquemas JSON convierte un JSON de muestra en un esquema listo para validadores en APIs, webhooks, archivos de configuración, canalizaciones de datos y documentación. Pega un objeto JSON representativo, un array o un flujo NDJSON, elige el estilo de inferencia y la herramienta creará un esquema con propiedades anidadas, reglas para elementos de array, valores anulables, ejemplos y notas legibles ruta por ruta.

¿Por qué utilizar un Generador de Esquemas JSON basado en muestras?

Escribir un esquema JSON a mano es preciso pero lento, especialmente cuando los datos contienen objetos anidados, arrays de registros, campos opcionales y valores anulables. Este generador te ofrece un primer borrador estructurado que captura la forma observada de tus datos JSON, y luego resalta los puntos donde todavía se requiere una revisión humana. Es útil para la validación de solicitudes de API, contratos de respuesta, proyectos de OpenAPI, cargas útiles de webhooks, flujos de eventos y esquemas de configuración.

Cómo utilizar

1. Pega un objeto JSON representativo, un array JSON o registros JSON delimitados por nuevas líneas en el editor de muestras.
2. Selecciona el borrador de JSON Schema y decide si deseas inferir campos requeridos, ejemplos, sugerencias de enumeraciones, formatos de cadena y objetos cerrados. De forma predeterminada, el borrador es Draft 2020-12, los campos requeridos se establecen como Observados en cada objeto, Detectar formatos, Incluir ejemplos e Inferir sugerencias de enumeraciones están activados, y Objetos cerrados está desactivado. El título del esquema comienza como GeneratedSchema.
3. Haz clic en Generar esquema JSON para inferir tipos, propiedades anidadas, elementos de array, campos nulos y sugerencias de validación.
4. Comprueba el mapa generado para ver cada ruta, tipo inferido, estado de requerido, formato y regla antes de usar el esquema.
5. Copia el esquema generado y perfecciona las reglas de validación específicas del dominio, como rangos exactos, patrones de ID y enumeraciones específicas del negocio.

Qué infiere el generador

• Tipos JSON principales: object, array, string, number, integer, boolean y null.
• Propiedades de objetos anidados y campos requeridos en función de lo que aparece en cada objeto observado.
• Esquemas de elementos de array fusionando los elementos observados en la muestra.
• Formatos de cadena comunes, incluidos email, URL, fecha, fecha y hora, UUID, IPv4 e IPv6.
• Ejemplos opcionales, sugerencias de enum, rangos numéricos observados y longitudes de cadena observadas.

Preguntas frecuentes

¿Qué hace este Generador de Esquemas JSON?

Lee un JSON de muestra y crea un JSON Schema que describe la forma de los datos observados. El generador infiere propiedades de objetos, arrays, tipos primitivos, valores nulos, ejemplos, sugerencias de enumeraciones, campos requeridos y formatos de cadena comunes.

¿Se puede utilizar un esquema generado en producción inmediatamente?

Utilízalo como un sólido punto de partida y luego revísalo. Los datos de muestra no pueden conocer todas las reglas de negocio, por lo que es posible que aún debas añadir patrones, rangos exactos, valores de enumeración permitidos, reglas de versión y configuraciones más estrictas de additionalProperties.

¿Qué borradores de JSON Schema son compatibles?

La herramienta puede generar esquemas para Draft 2020-12, Draft 2019-09 y Draft-07 configurando el URI $schema. La estructura inferida es intencionalmente compatible con los validadores comunes.

¿Cómo se infieren los campos requeridos?

Cuando la inferencia de requeridos está activada, una propiedad se marca como requerida solo cuando aparece en cada objeto observado en ese nivel. Para un array de objetos, esto significa que el campo debe aparecer en cada elemento de la muestra.

¿La herramienta admite arrays de objetos y NDJSON?

Sí. Un array JSON de nivel superior se trata como un esquema de array, y los registros JSON delimitados por nuevas líneas se tratan como un array de registros. Las propiedades de los elementos se fusionan a partir de las muestras observadas.