Despliegue de una API

El asistente gráfico proporciona una opción que añade la API a un producto y despliega el producto en un catálogo. Cuando un producto se encuentra en estado transferido (staged), ningún desarrollador podrá verlo ni suscribirse al mismo. La característica de sindicación en IBM® API Connect significa que si Espacios están habilitados para un catálogo, los productos sólo se pueden transferir a un Espacio dentro de dicho catálogo.

Antes de empezar

Asegúrese de que tiene un catálogo al que transferir en las interfaces de usuario (IU) de API Manager o API Designer . Para obtener más información, consulte Creación y configuración de catálogos.

Asegúrese de que el catálogo tenga configurado al menos un servicio de pasarela.

Nota: Todas las referencias de este tema a un catálogo también se pueden aplicar a Espacios en un catálogo, a menos que se especifique lo contrario. Para obtener más información sobre Espacios, consulte Uso de la sindicación en API Connect.

Para completar las tareas de gestión de productos que se describen en este tema, debe ser el propietario de la organización de proveedores de API o tener asignado el permiso Producto > Etapa para el catálogo de destino o Espacio. Para obtener información sobre cómo configurar permisos de gestión de productos para un catálogo o Espacio, consulte Creación y configuración de catálogos o Gestión del acceso 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 utilizando la interfaz de usuario de API Manager basada en navegador. El despliegue no está disponible cuando se trabaja fuera de línea en API Designer.

Un Catálogo es un objetivo de puesta en escena, y se comporta como una partición lógica del DataPower® Gateway y el Portal CMS.

La validación del archivo de definición de API se produce durante el proceso de transferencia o publicación. Se produce la validación siguiente:
  • Validación en el esquema OpenAPI utilizando el analizador Swagger de herramientas de desarrollo de API (https://www.npmjs.com/package/@apidevtools/swagger-parser).
  • Validación con respecto a las propiedades de extensión de IBM .
  • Validación semántica, que incluye los tipos de validación siguientes:
    • Garantizar que si una OpenAPI es aplicada por una pasarela API Connect, entonces el esquema debe ser HTTPS, o el nombre del parámetro para un esquema de seguridad de clave API en la cabecera debe ser X-IBM-Client-Id o X-IBM-Client-Secret.
    • Asegúrese de que si una API Connect Gatewayno aplica OpenAPI , se debe proporcionar un host .
    • Desreferenciar las referencias locales en el archivo de definición (es decir, los valores de las propiedades $ref ) y asegurarse de que son punteros JSON válidos dentro del archivo.
Nota: Si el archivo OpenAPI que define la API utiliza un campo $ref para hacer referencia a un fragmento de código OpenAPI que está 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 transfiera o publique (el campo $ref sólo está soportado si está utilizando el API Connect kit de herramientas de desarrollador). Para obtener más información, consulte Utilización de $ref para reutilizar fragmentos de código en los archivos OpenAPI.

Procedimiento

  1. En el panel de navegación, pulse Icono de desarrollo en el panel de navegación Desarrollary, a continuación, seleccione la pestaña API.
    Se abre la página Desarrollar .
  2. Opcional: Si tiene cuentas en varias organizaciones de proveedores, puede seleccionar una nueva organización de proveedores para transferir y publicar en el menú Organización .
  3. Puede transferir una API desde la página de listado Desarrollar o desde la propia definición de API.
    1. Para transferir una API desde la página de listado Desarrollar , pulse el icono de menú de opciones icono de opciones junto a la API necesaria y, a continuación, seleccione Etapa.
    2. Para desplegar una API desde la definición de API, siga estos pasos:
      1. Pulse el título de la API con la que desee trabajar.
      2. Pulse el icono del menú de opciones:
        Captura de pantalla que resalta el icono del menú de opciones
      3. Pulse Etapa.
  4. Elija una de estas acciones:
    • Para desplegar la API añadiéndola a un producto nuevo:
      1. Seleccione Nuevo producto - Publicar mediante un producto nuevo.
      2. Cuando se le solicite, especifique un Título y una Versión.
      3. El Nombre del producto se especifica automáticamente. El nombre es el que se utiliza para hacer referencia al producto en mandatos de CLI. Consulte la documentación de referencia de la CLI del kit de herramientas.
      4. Pulse Siguiente.
    • Para desplegar la API añadiéndola a un producto existente:
      1. Seleccione Producto existente - Publicar utilizando un producto existente
      2. Seleccione el producto que desea utilizar.
      3. Pulse Siguiente.
  5. En la página Etapa a , seleccione el catálogo al que desea transferir el producto.
    Nota: Los Catálogos entre los que puede seleccionar son los definidos para el servidor de gestión y la organización de proveedores a los que está conectado.

    Si utiliza la interfaz de usuario Gestor de API, los detalles de la conexión vienen determinados por la dirección Gestor de API URL que abra y el identificador de usuario con el que se conecte. Si utiliza la interfaz de usuario API Designer, proporcione los datos del servidor de gestión y el ID de usuario en la ventana de inicio de sesión que se abre al iniciar por primera vez API Designer; consulte Inicio de sesión en API 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.

  6. Si, cuando el producto por etapas se publique posteriormente, desea que se publique sólo en los servicios de pasarela seleccionados, seleccione Publicar en servicios de pasarela específicosy, a continuación, 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 API Connecttipos de pasarela.
  7. Pulse Etapa.

Resultados

El producto se despliega en un catálogo. Puede ver el estado del producto en el catálogo en Gestor de API. Si ha transferido el producto desde API Designer, asegúrese de que ha iniciado sesión en Gestor de API con el mismo nombre de usuario y contraseña que ha utilizado para API Designer. Pulse Icono Gestionar en el panel de navegación de la interfaz de usuario de API Manager Gestionar en la interfaz de usuario de API Manager 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 El ciclo de vida del 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 más información sobre la configuración de las aprobaciones del ciclo de vida del producto para un catálogo, consulte Creación y configuración de catálogos. Para obtener más información sobre la aprobación de solicitudes, consulte Aprobación de solicitudes de suscripción y ciclo de vida de productos.

Si el producto no contiene planes, se añade automáticamente un plan denominado Plan predeterminado al producto en el catálogo.