Despliegue de un borrador de producto

Despliegue un borrador de producto en un catálogo para crear una versión específica de ese producto antes de la publicación. Cuando un producto se encuentra en estado transferido (staged), ningún desarrollador podrá verlo ni suscribirse al mismo.. La característica de sindicación de IBM® API Connect significa que si hay Espacios habilitados para un catálogo, los productos solo se podrán transferir a un Espacio dentro de ese catálogo.

Antes de empezar

Asegúrese de tener un catálogo al que transferir en las interfaces de usuario de Gestor de API o API Designer. Puede obtener información adicional consultando Creación y configuración de catálogos.
Nota: Todas las referencias en este tema a un catálogo también se podrán aplicar a Espacios en un catálogo, a menos que se especifique lo contrario. Puede obtener información adicional sobre Espacios consultando Uso de la sindicación en IBM API Connect.

Para completar las tareas de gestión de productos descritas en este tema, hay que ser el propietario de la organización de proveedor de API o tener asignado el permiso Producto y Transferir en el catálogo o Espacio de destino. Para obtener información sobre la configuración de permisos de gestión de producto de un catálogo o un Espacio, consulte Creación y configuración de catálogos o Gestión de accesos de usuario en un espacio.

Acerca de esta tarea

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o bien utilizando la interfaz de usuario de Gestor de API basada en navegador.

El despliegue no está disponible cuando se trabaja fuera de línea en API Designer.

Un catálogo es un destino de transferencia y se comporta como una partición lógica de DataPower Gateway y Portal de desarrollador.

Un producto se puede preparar antes de confirmar para que se puedan dar las aprobaciones oportunas internamente en la organización para que luego se pueda publicar. Para obtener información sobre cómo configurar las aprobaciones del ciclo de vida de un Producto de un Catálogo, consulte Creación y configuración de Catálogos. Para obtener información sobre la aprobación de solicitudes, consulte Ciclo de vida de aprobaciones de Producto y solicitudes de suscripción. Puede obtener información sobre la publicación de un producto consultando Publicación de un producto.

No se puede volver a desplegar una versión de producto existente en un catálogo de producción. Si actualiza una API, debe crear una nueva versión de dicha API. A continuación, cree una nueva versión del producto para que incluya la versión más reciente de la API. Para obtener más información sobre la creación de nuevas versiones de APIs y productos, consulte Creación de una versión nueva de una definición de API y Creación de una versión nueva del producto. Si se han habilitado Espacios en un catálogo de producción, no se puede volver a desplegar la misma versión de API o de producto en ningún Espacio del catálogo.

No obstante, puede volver a desplegar una versión del producto en el catálogo de recinto de pruebas o en otro catálogo que no sea de producción para facilitar la prueba iterativa. Tenga en cuenta que cuando vuelve a desplegar una versión del producto en un catálogo que no es de producción, se suprimen las suscripciones de aplicación. Esto se lleva a cabo para facilitar el despliegue mediante scripts en un entorno de integración continuo, en el que el proceso de volver a crear las suscripciones de aplicación se controla mediante scripts. Si están habilitados los Espacios en un catálogo no de producción y vuelve a desplegar la versión del producto en un Espacio distinto al espacio en que se ha desplegado previamente, se elimina del Espacio anterior y se despliega en el Espacio especificado recientemente. Si la integración de facturación está habilitada en un producto, no es posible volver a desplegar la misma versión de producto en un catálogo de producción o no de producción. Para obtener más información acerca de la integración de facturación, consulte Monetización de los productos.

La validación del archivo de definición OpenAPI de API se produce durante el proceso de despliegue o publicación. Se produce la validación siguiente:
  • Validación contra el esquema de especificación OpenAPI
  • Validación contra propiedades de extensión de IBM
  • Validación semántica, que incluye los tipos de validación siguientes:
    • Asegurarse de que si una Pasarela de API Connect aplica una API, el esquema debe ser HTTPS o el nombre de parámetro de un esquema de seguridad de clave de API en la cabecera debe ser X-IBM-Client-Id o X-IBM-Client-Secret.
    • Asegurarse de que si una Pasarela de API Connect no aplica la API, se debe proporcionar un host
Nota: Si el archivo de OpenAPI que define el API utiliza un campo $ref para referenciar un fragmento de código de OpenAPI definido en un archivo aparte, el campo $ref se sustituye por el contenido del archivo de destino antes de que el producto que contiene la API se despliegue o publique (el campo $ref solo está soportado si utiliza el kit de herramientas del desarrollador de API Connect for IBM Cloud). Para obtener más información, consulte Utilización de $ref para reutilizar fragmentos de código en los archivos de OpenAPI.

Procedimiento

Para desplegar un producto, siga estos pasos:

  1. Opcional: Si tiene cuentas en varias organizaciones de proveedores, puede seleccionar una organización de proveedores nueva para desplegar y publicar en el menú Organización.
  2. En el panel de navegación, pulse Icono Desarrollar del panel de navegación Desarrollar.
  3. Seleccione la pestaña Productos.
  4. Puede desplegar un producto desde la página de lista Desarrollar o desde el propio producto.
    1. Para desplegar un producto desde la página de lista Desarrollar, pulse el icono de menú de opciones icono de opciones junto al producto en cuestión y, a continuación, seleccione Desplegar.
    2. Para desplegar un producto desde el propio producto, siga estos pasos:
      1. Pulse la versión de producto con la que desea trabajar.
      2. Pulse el icono del menú de opciones:
        Captura de pantalla que resalta el icono del menú de opciones
      3. Seleccione Desplegar.
  5. Seleccione el catálogo en el que desea desplegar el producto.
  6. Si se han habilitado Espacios en el catálogo seleccionado, seleccione el Espacio que necesita.
    Nota: Los catálogos entre los que puede seleccionar son los que están definidos para el servidor de gestión y la organización de proveedores a la que está conectada.

    Si se utiliza la interfaz de usuario del Gestor de API, los detalles de conexión están determinados por el URL del Gestor de API que se abre y el ID de usuario con el que se inicia la sesión. Si se utiliza la interfaz de usuario del API Designer, proporcione los detalles del servidor de gestión y el ID de usuario en la ventana de inicio de sesión que se abre la primera vez que inicia API Designer; consulte Inicio de sesión en API Connect Designer.

    Para obtener detalles sobre cómo crear un catálogo en una organización de proveedores, consulte Creación y configuración de catálogos.

  7. Si, cuando se publica el producto desplegado, desea publicarlo solo en servicios de pasarela seleccionados, seleccione Publicar en servicios de pasarela específicos y seleccione los servicios de pasarela necesarios. Sólo se listan los servicios de pasarela cuyo tipo coincide con el valor de tipo de pasarela del producto. Para obtener información sobre los tipos de pasarela, consulte Tipos de pasarela de API Connect.
  8. Pulse Desplegar.

Resultados

El producto se despliega en un catálogo. Puede ver el estado del producto en el catálogo en el Gestor de API. Si ha desplegado el producto desde API Designer, asegúrese de que ha iniciado sesión en el Gestor de API con el mismo nombre de usuario y la misma contraseña que ha utilizado para API Designer. Pulse Icono Gestionar del panel de navegación del Gestor de API Gestionar en la interfaz de usuario del Gestor de API y, a continuación, seleccione el catálogo necesario. El producto se muestra con un estado Desplegado.

Para obtener información sobre el ciclo de vida de un producto, consulte Ciclo de vida de un producto.

Si se necesita aprobación para desplegar productos en el catálogo, se envía una solicitud de aprobación y el producto pasa al estado pendiente; el producto se despliega cuando se aprueba la solicitud. Si no se requiere aprobación, el producto se despliega inmediatamente.

Para obtener información sobre cómo configurar las aprobaciones del ciclo de vida de un Producto de un Catálogo, consulte Creación y configuración de Catálogos. Para obtener información sobre la aprobación de solicitudes, consulte Ciclo de vida de aprobaciones de Producto y solicitudes de suscripción.

Qué hacer a continuación

  • Publique el producto para que los desarrolladores de aplicaciones accedan a él en el Portal de desarrollador. Para obtener más información, consulte Publicación de un producto.