Activación de una API

Después de haber creado una definición de API, puede activarla para publicar automáticamente el documento de API y ponerla a disposición de las pruebas.

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.

Cuando activa una API, API Connect realiza automáticamente las acciones siguientes:

  • Crea un borrador de producto, añade la API al producto y publica el producto en el catálogo de recinto de pruebas para que la API esté disponible para llamadas. El producto tiene el título título_api auto product. Tenga en cuenta que si más adelante desea suprimir el borrador del producto, no puede suprimirlo directamente; en su lugar, suprima la API y el borrador del producto se suprimirá junto con la API; consulte Supresión de una definición de API. Si desea eliminar el producto de los catálogos en los que se publica, debe hacerlo por separado; consulte Eliminación de un producto de un catálogo
  • Suscribe la aplicación de prueba de recinto de pruebas al producto de forma que pueda probar inmediatamente la API en el entorno de prueba. Para obtener información sobre cómo probar una API, consulte Prueba de una API.

Para activar una API, debe tener asignado un rol con los permisos Product:Manage y Subscription:Manage. El rol de desarrollador presuministrado tiene estos permisos de forma predeterminada; si se le asigna un rol personalizado, debe tener estos permisos. Para obtener más información, consulte Creación de roles personalizados.

Nota:
  • La activación de la API no se completará correctamente si la aprobación del ciclo de vida se ha habilitado en el catálogo del recinto de pruebas para las acciones Desplegar, Publicar o Sustituir. Si alguna de estas aprobaciones de ciclo de vida está habilitada, para poder activar una API deben estar inhabilitadas; para obtener información sobre los valores de aprobación de ciclo de vida, consulte Creación y configuración de catálogos.
  • Los productos que contienen un API con una propiedad Swagger que usa una expresión regular que incluye aserciones de búsqueda anticipada como, por ejemplo, "(?" no se pueden validar ni publicar. Se obtiene un mensaje de error. Por ejemplo: 
    Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
    definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400

Procedimiento

Para activar una API y publicar automáticamente el documento de API, realice los pasos siguientes:

  1. En el panel de navegación, pulse Icono de desarrollo en el panel de navegación de la interfaz de usuario de la API Desarrollary, a continuación, seleccione la pestaña API.
  2. Pulse el título de la API con la que desee trabajar.
  3. En la pestaña Probar, pulse Configuración de destino. Se abre la página Preferencias .
  4. Establezca el conmutador Publicación automática en la posición Activada : Captura de pantalla que resalta el control deslizante para publicar una API

Resultados

Una vez completada correctamente, la API se muestra como Activada:Captura de pantalla que resalta el control deslizante para publicar una API

Puede detener la API moviendo el control deslizante de activación a la posición Desactivado : Captura de pantalla que resalta el control deslizante para detener la publicación de una API

Si detiene una API, la suscripción de aplicación se suprime y el producto automático se elimina del catálogo de recinto de pruebas.
Nota: Puede seleccionar un catálogo de su elección, o puede optar por utilizar el catálogo de recinto de pruebas seleccionando Utilizar el catálogo de recinto de pruebas incorporado predeterminado. Para obtener más información, consulte Especificación de las preferencias de prueba para una API.

Si realiza un cambio en la API, ésta vuelve a publicarse automáticamente. También puede volver a publicar una API en ejecución deteniéndola manualmente y luego reactivándola.

El indicador de error muestra si hay errores de validación en el origen de OpenAPI para la definición de API. Si existen errores, pulse el icono para obtener más detalles:Captura de pantalla que muestra una API con un error de validación

También puede activar una API durante el proceso de creación y en la página de prueba de la API; consulte Creación de una definición de API y Prueba de una API.

Nota: Si una API de OpenAPI 3 contiene un comodín de respuesta (que no está soportado), la publicación está inhabilitada para dicha API. Debe corregir el problema antes de poder publicar la API.