#283 · Herramienta para desarrolladores

OpenAPI Schema Example Generator

Genera ejemplos JSON a partir de esquemas OpenAPI, resolviendo tipos, propiedades, required, enum, example y valores por defecto. Todo el procesamiento principal ocurre localmente en el navegador, por lo que puedes revisar contratos y fragmentos sin depender de un servicio remoto.

Datos de entrada

Contrato API
Espacio publicitario

Cómo usar esta herramienta para desarrolladores

  1. Pega el documento JSON en el área de entrada o carga un archivo.
  2. Revisa el formato y, cuando exista, selecciona la presentación del resultado.
  3. Pulsa Generar ejemplo o usa Ctrl/Cmd + Enter.
  4. Comprueba el resumen, las métricas y la interpretación antes de copiar o descargar.

Qué hace esta herramienta para desarrolladores

Genera ejemplos JSON a partir de esquemas OpenAPI, resolviendo tipos, propiedades, required, enum, example y valores por defecto. El resultado se calcula a partir de la estructura real del documento y no de una simple búsqueda de texto.

Se analiza el JSON, se recorren las secciones relevantes del contrato y se construye una salida estructurada junto con métricas de diagnóstico.

La herramienta no ejecuta llamadas HTTP ni valida el comportamiento real de un servidor. Utiliza el resultado como apoyo para revisar el contrato.

Ejemplo

El resultado depende de la operación; el ejemplo incluido en el botón «Ejemplo» reproduce un caso válido para esta herramienta.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": 1
    },
    "name": {
      "type": "string",
      "example": "Luna"
    },
    "active": {
      "type": "boolean"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "api",
          "docs"
        ]
      }
    }
  }
}

Casos de uso

  • Revisión de contratos antes de publicar una API.
  • Preparación de documentación y pruebas.
  • Diagnóstico durante migraciones de versiones OpenAPI.
  • Apoyo a generación de clientes, mocks y SDK.

Consejos para obtener resultados fiables

  • Valida primero la sintaxis JSON.
  • Conserva una copia del contrato original antes de convertirlo.
  • Revisa referencias $ref y componentes compartidos.
  • No interpretes una conversión parcial como certificación de compatibilidad.
  • Prueba el resultado con tu validador OpenAPI habitual.

Detalles del procesamiento

El código recorre únicamente las estructuras necesarias para esta función y evita solicitudes de red. Las salidas descargables se generan desde el contenido calculado en la página.

No se resuelven referencias remotas y no se implementa un parser YAML. Las extensiones x-* y combinaciones avanzadas de JSON Schema pueden requerir comprobación adicional.

Preguntas frecuentes

¿Qué formato de entrada acepta OpenAPI Schema Example Generator?

La versión actual procesa JSON válido directamente en el navegador. Si tu contrato está en YAML, conviértelo primero a JSON para evitar una interpretación parcial.

¿OpenAPI Schema Example Generator modifica el archivo original?

No. El contenido se procesa en memoria y el resultado se muestra por separado; el texto de entrada no se sobrescribe.

¿Puedo usar OpenAPI Schema Example Generator con OpenAPI 3.0 y 3.1?

Depende de la operación concreta. Las estructuras compartidas entre 3.0 y 3.1 funcionan, mientras que las diferencias específicas de JSON Schema requieren revisión cuando afectan al resultado.

¿Qué debo revisar si OpenAPI Schema Example Generator muestra un error?

Comprueba primero que el JSON sea válido y que los campos esperados estén en la ubicación definida por OpenAPI o Swagger. El mensaje de error señala la condición que impidió continuar.

¿Los datos enviados a OpenAPI Schema Example Generator salen del navegador?

No para la función principal de esta página. El procesamiento se realiza con JavaScript local y no necesita una API externa para analizar o convertir el texto.

Resumen del módulo

MóduloFunción
EntradaJSON local
ProcesamientoJavaScript en el navegador
SalidaTexto, tabla y JSON cuando procede