Saltar al contenido

Importar un documento OpenAPI (Swagger) para crear un endpoint en Jitterbit App Builder

Introducción

Desde la versión 4.45, puedes crear un endpoint REST a partir de un documento OpenAPI (Swagger). App Builder utiliza la biblioteca OpenAPI.net y admite versiones de documentos desde Swagger 2.0 hasta OpenAPI 3.1 inclusive.

Puedes crear un endpoint desde cualquiera de estos lugares:

  • IDE > Servidores de Datos

  • App Workbench > Fuentes de Datos

Esta página muestra los pasos para ambos.

Crear un endpoint REST a partir de un documento OpenAPI (Swagger) a través del IDE

Sigue estos pasos:

  1. Selecciona IDE > Servidores de Datos.

  2. Haz clic en el botón + Servidor. Se abre el diálogo Servidor.

  3. Establece valores para lo siguiente:

    • Nombre del Servidor: Ingresa un nombre para el servidor.

    • Tipo: Selecciona REST API. (REST se selecciona automáticamente para Subtipo.)

    • URL: Ingresa la raíz del endpoint (URL base).

    • (Opcional) Descripción: Ingresa una descripción.

  4. Haz clic en el botón Guardar.

    El siguiente ejemplo utiliza la URL del documento de prueba OpenAPI https://ipinfo.io/developers/openapi.yaml:

    Diálogo del Servidor

  5. En el diálogo Servidor, haz clic en el ícono Endpoints.

  6. En el panel Servicio Web, haz clic en el botón Importar. Se abre la primera página del diálogo del asistente Importación de Servicio Web:

    Diálogo de Importación de Servicio Web

  7. Selecciona una de las siguientes pestañas, dependiendo de cómo deseas proporcionar tu documento:

    • URL: Selecciona para proporcionar una URL para el documento.

    • Documento: Selecciona para pegar el contenido de un documento.

    • Subir: Selecciona para subir un documento desde tu sistema de archivos.

  8. Haz clic en el botón Siguiente. Se abre la segunda página del diálogo del asistente de Importación de Servicio Web:

    Crear Endpoints

  9. (Opcional) Para importar uno o más endpoints, haz cualquiera de lo siguiente:

    • Ingresa un patrón en el campo Importar por Nombre, luego haz clic en el botón Importar.

      Un patrón es una lista delimitada por comas de expresiones comodín que seleccionan un subconjunto de tablas para importar. Cada patrón utiliza la sintaxis LIKE de mvSQL. Puedes usar % para coincidir con cero o más caracteres, y _ para coincidir con un solo carácter. Los caracteres entre corchetes (por ejemplo, [abc]) coinciden con cualquier carácter en el grupo.

    • Haz clic en cualquiera de los botones Importar Esquema para importar endpoints.

  10. Haz clic en el botón Finalizar.

Crear un endpoint REST desde un documento OpenAPI (Swagger) a través del App Workbench

Sigue estos pasos:

  1. Selecciona App Workbench desde el panel de acciones, o Workbench desde el menú de la aplicación, luego haz clic en Fuentes de Datos.

  2. Haz clic en el botón + Fuente. Se abre el diálogo Agregar una Fuente a tu Aplicación.

  3. Selecciona la opción Nueva Conexión, luego haz clic en el botón Siguiente. Se abre la página del asistente Elegir Tipo de Conexión.

  4. En Categoría de Conexión, selecciona la opción REST.

  5. En Tipos de Conexiones, selecciona la opción REST API, luego haz clic en el botón Siguiente.

  6. Selecciona o configura un proveedor de seguridad, o haz clic en el botón Omitir. Se abre la página del asistente Crear Nueva Conexión.

  7. Haz clic en el botón Importar. Se abre el diálogo Importar Nueva Conexión:

    Importar Nueva Conexión

  8. Selecciona una de las siguientes pestañas, dependiendo de cómo quieras proporcionar tu documento:

    • URL: Selecciona para proporcionar una URL para el documento.
    • Documento: Selecciona para pegar el contenido de un documento.
    • Subir: Selecciona para subir un documento desde tu sistema de archivos.

  9. Haz clic en el botón Siguiente. Se abre el diálogo Crear Puntos Finales:

    Crear Puntos Finales

  10. Haz clic en el botón Importar. Se abre nuevamente el diálogo Importación de Servicio Web:

    Importaciones de Servicio Web

  11. Haz clic en el botón Siguiente.

  12. (Opcional) Para importar uno o más puntos finales, haz cualquiera de lo siguiente:

    • Ingresa un patrón en el campo Importar por Nombre, luego haz clic en el botón Importar.

      Un patrón es una lista delimitada por comas de expresiones comodín que seleccionan un subconjunto de tablas para importar. Cada patrón utiliza la sintaxis LIKE de mvSQL. Puedes usar % para coincidir con cero o más caracteres, y _ para coincidir con un solo carácter. Los caracteres entre corchetes (por ejemplo, [abc]) coinciden con cualquier carácter en el grupo.

    • Haz clic en cualquiera de los botones Importar Esquema para importar puntos finales.

  13. Haz clic en el botón Finalizar. La página del asistente Crear Puntos Finales vuelve a aparecer:

    Crear Puntos Finales

  14. Para probar los puntos finales, haz clic en cualquiera de los íconos en la columna Estado. Cuando sea exitoso, el ícono cambia a :

    Crear Puntos Finales

  15. Haz clic en el botón Siguiente. Se abre el diálogo Resumen de Nueva Fuente de Datos:

    Crear Puntos Finales

  16. Haz clic en el botón Listo.