Saltar al contenido
Asistente de esquemas

JSON a esquema OpenAPI

Crea un esquema OpenAPI 3.1.0 a partir de un JSON de ejemplo. La salida es un documento mínimo: info tiene el título Generated API y la versión 1.0.0, y el esquema inferido de tu muestra va en components.schemas.Root. Cuando los elementos de un array tienen formas distintas se fusionan en un solo esquema, y solo las claves presentes en todos los elementos pasan a required. Una cadena de fecha y hora como 2024-01-02T03:04:05Z recibe format: date-time, y null pasa a type: "null", al estilo de OpenAPI 3.1. Puedes pegarlo en Swagger Editor para inspeccionarlo, pero paths está vacío, así que añade tú los endpoints, además de restricciones como description, example y enum. Todo se procesa en tu navegador y tu JSON no se envía.

Guía

Cómo usarlo y características

  • Pega el JSON en el campo de entrada y pulsa «Convertir a OpenAPI».
  • Los objetos se expanden a JSON Schema con properties y la lista de required.
  • Los arreglos infieren el tipo de elementos; si hay mezcla, la salida usa oneOf.
  • Puedes copiar el resultado o limpiar los campos para empezar de nuevo.
Ejemplos

Ejemplos de entrada y salida

Infer schema from a profile object

Entrada
{"name":"Jane","email":"jane@example.com","verified":true}
Salida
{
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "email": {"type": "string", "format": "email"},
    "verified": {"type": "boolean"}
  },
  "required": ["name", "email", "verified"]
}
FAQ

Preguntas frecuentes

  • ¿Qué documento OpenAPI genera?

    Un documento OpenAPI 3.1.0 mínimo. `info` tiene el título `Generated API` y la versión `1.0.0`, `paths` está vacío y el esquema inferido de tu muestra va en `components.schemas.Root`.
  • ¿Puedo usarlo en Swagger Editor?

    Sí. Pega la salida y podrás inspeccionar el esquema `Root`. `paths` está vacío, así que añade tú los endpoints.
  • ¿Qué pasa cuando los elementos de un array tienen formas distintas?

    Se fusionan en un solo esquema. Solo las claves presentes en todos los elementos pasan a `required`; las de solo algunos, no. `oneOf` aparece únicamente cuando difiere el tipo de valor.
  • ¿Cómo se tratan las cadenas de fecha y hora?

    Una fecha y hora ISO 8601 como `2024-01-02T03:04:05Z` pasa a `type: string` con `format: date-time`. Una fecha sola, como `2024-01-02`, es un `string` normal.
  • ¿Y `null` y los arrays vacíos?

    `null` pasa a `type: "null"` (al estilo 3.1). Un array vacío pasa a `items: {}` porque se desconoce la forma del elemento.
  • ¿Se envía mi JSON a algún sitio?

    No. La conversión se hace por completo en tu navegador.
Casos de uso

Usos habituales

  • Redactar esquemas

    Transforma ejemplos JSON en esquemas OpenAPI base para sembrar la documentación o la generación de mocks.
  • Compartir rápido lo que se espera de un endpoint

    Convierte ejemplos de petición/respuesta y pégalos en PR o issues para acordar los detalles del contrato.
  • Comprobar la coherencia con especificaciones existentes

    Compara los esquemas generados con las definiciones actuales para detectar campos que necesitan actualizarse.
Notas

Notas y limitaciones

  • `paths` está vacío

    No se incluyen los endpoints (ruta, método, petición y respuesta). Lo que se obtiene es el esquema bajo `components.schemas`.
  • Infiere a partir de una sola muestra

    No se incluyen `description`, `example`, `enum` ni restricciones de longitud o rango. Añádelos a mano según tu especificación.
  • Usa las convenciones de OpenAPI 3.1

    `null` pasa a un `oneOf` con `type: "null"`; no se usa `nullable: true`. Las herramientas que asumen 3.0 o anterior necesitan reescribirlo.
  • Que una clave sea obligatoria depende de la muestra

    Las claves presentes en todos los elementos del array pasan a `required`. Una clave que simplemente está en todos los elementos de la muestra también será obligatoria, así que compruébalo con la especificación real.
Acerca de

Acerca de esta herramienta

Generador de schema OpenAPI desde JSON

Convierte una muestra JSON en un schema OpenAPI para documentar responses, requests y componentes reutilizables. Ayuda a crear una base rápida para components.schemas sin escribir cada propiedad manualmente.

Cuándo resulta útil

  • Documentar endpoints: parte de una respuesta real para crear el schema inicial.
  • Crear contratos de API: revisa tipos, propiedades requeridas y estructuras anidadas.
  • Acelerar documentación: genera borradores para Swagger u OpenAPI.

Revisa manualmente campos opcionales, formatos especiales, arrays y restricciones como enum, minLength o format.

Artículos para esta herramienta

Artículos recientes