Creación de una API de proxy REST a partir de un servicio OpenAPI existente

Si tiene un servicio de destino descrito OpenAPI existente que desea exponer a través de una definición de API de IBM® API Connect , puede crear una API de proxy y especificar el punto final de destino.

Para componer una API proxy a partir de un servicio OpenAPI existente, siga estos pasos.

1. En el panel de navegación, pulse Desarrollary, a continuación, pulse Añadir > API.
   Se visualizará la pantalla Seleccionar tipo de API.
2. Seleccione OpenAPI 2.0 o OpenAPI 3.0 según la versión de la especificación OpenAPI en la que se va a basar la API.
3. Seleccione Desde el servicio OpenAPI existentey pulse Siguiente.
4. Para cargar la información de servicio de un archivo OpenAPI puede arrastrar y soltar el archivo o examinar y seleccionar el archivo que desea utilizar. Los tipos de archivo válidos son YAML, YML, etc.
   • Pulse Examinar y busque el archivo OpenAPI.
   • Arrastre y suelte el archivo en el área activa.
   Después de cargar el archivo, la especificación OpenAPI se evalúa y se visualiza un mensaje que indica si es válida.
5. Pulse Siguiente. Especifique el resumen de API en la sección Información. Puede ajustar la API después de crearla.
   • El Título puede incluir caracteres especiales, pero debe ser corto para que se pueda visualizar fácilmente en la interfaz de usuario.
   • El Nombre se especifica automáticamente. El valor del campo Nombre es una serie única que se utiliza para identificar la API en los mandatos de CLI developer toolkit . Para ver los mandatos de CLI para gestionar borradores de API, consulte la documentación de referencia de CLI del kit de herramientas.
   • La Versión corresponde al valor de la propiedad info.version de la definición OpenAPI de la API. Se recomienda el esquema de numeración de versión de version.release.modification ; por ejemplo, 1.0.0.
   • La Vía de acceso base es el segmento de URL de la API y no incluye el nombre de host ni ningún segmento adicional para vías de acceso u operaciones. La vía de acceso base no puede incluir caracteres especiales y debe empezar por un carácter / aunque esté vacía.
   • La Descripción opcional ayuda a identificar la API.
6. Pulse Siguiente. En la sección Proteger, configure la seguridad de la API que necesita.
   • Proteger mediante ID de cliente : seleccione esta opción para exigir que una aplicación proporcione un ID de cliente (Clave de API). Esto hace que el parámetro X-IBM-Client-Id se incluya en la cabecera de solicitud para la API. Si se selecciona, puede seleccionar si se deben limitar las llamadas de API en función de la clave (por ID de cliente):
     • Limitar las llamadas de API en función de la clave - Si se selecciona, debe configurar el límite de velocidad que necesite. Los límites de velocidad controlan el número máximo de llamadas permitidas durante de un periodo de tiempo (hora, minuto, mes o día). Por ejemplo, 100 llamadas por hora.
   • CORS - Seleccione esta opción para habilitar el soporte de uso compartido de recursos de diversos orígenes (CORS) para la API. Esto permite que se pueda acceder a la API desde otro dominio.
     Nota:

     • El soporte de CORS sólo está disponible en DataPower® API Gateway.
     • Cuando CORS está habilitado, la pasarela de API ejecuta la política de preflujo cors para manejar todas las solicitudes CORS efectuadas a la API.
     • Cuando CORS está habilitado y se recibe una solicitud de verificación, sólo se realizan las siguientes acciones de API:
       • La política de preflujo cors configura las cabeceras de respuesta adecuadas.
       • Se establecen las cabeceras de respuesta.
     • Cuando se recibe una solicitud de verificación, el indicador request.attributes.isCORSPreflight se establece en true.
     • Para todas las solicitudes de verificación, las políticas de preflujo security y client-identification siempre se pasan por alto, independientemente de si CORS está habilitado.
7. Opcional: Seleccione Activar API si desea utilizar inmediatamente la API para un mayor desarrollo y pruebas.
   Nota:

   • Cuando selecciona la opción Activar 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. Este producto no es visible en la vista Desarrollar y no puede suprimirlo directamente. Sin embargo, si suprime la API, el borrador de producto se suprime junto con la API; consulte Supresión de una definición de API. El producto es visible en cualquier catálogo en el que se haya publicado. Si desea eliminar el producto de un catálogo, 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.
   • No puede utilizar la opción Activar API si la aprobación del ciclo de vida está habilitada en el catálogo Recinto de pruebas para las acciones Etapa, Publicar o Sustituir. Si alguna de estas aprobaciones de ciclo de vida está habilitada, para poder utilizar la opción Activar 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.
   • Para utilizar la opción Activar API , debe tener asignado un rol que tenga 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.
8. Pulse Siguiente para crear la definición de API.

   El panel Resumen muestra mensajes a medida que se crea la definición y se aplican las opciones de seguridad y los límites de velocidad seleccionados.

   Si ha seleccionado Activar API, el asistente rellena un punto final de API URL que puede utilizar en las pruebas. Si también ha seleccionado Proteger mediante ID de cliente, el asistente muestra un ID de cliente y un secreto de cliente que puede utilizar.

9. Seleccione una de las siguientes opciones:
   • Para configurar la API con mayor detalle, pulse Editar API. Para obtener detalles, consulte Edición de una definición de API.
   • Si no desea seguir configurando la API en este momento, pulse el enlace Desarrollar de la indicación de ruta para volver a la página de bienvenida; a continuación, puede pasar inmediatamente a otra tarea. Para obtener detalles sobre cómo configurar la API más adelante, consulte Edición de una definición de API.