Creación de una API de proxy SOAP a partir de un servicio WSDL existente

Editar en línea

Si tiene un servicio SOAP definido en un archivo WSDL , puede utilizar el archivo WSDL para crear una API de proxy SOAP de API Connect que llame a ese servicio SOAP.

Acerca de esta tarea

Draft comment: gb042610
Marking all content that relates to importing from a URL as Future, as this option has been deferred: https://github.ibm.com/velox/ui/issues/5878 JenD Mar2018

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.

Para realizar esta tarea, debe tener asignado un rol que tenga los permisos Api-Drafts:Edit, Settings:View y App:View. 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: De forma predeterminada, la API de proxy SOAP que se crea tendrá la vía de acceso base establecida en el nombre de servicio WSDL. Puede editar la API de proxy SOAP para cambiar esta vía de acceso base.
Puede añadir una API SOAP para exponer un servicio SOAP existente proporcionando el archivo WSDL que define dicho servicio existente de una de las maneras siguientes:
  • Si el archivo WSDL es un archivo autónomo sin dependencias externas, puede cargar el archivo .wsdl desde un directorio para crear la definición de API SOAP.
  • Puede proporcionar uno o más archivos WSDL en un único archivo .zip que contenga los archivos WSDL y los esquemas necesarios.

    Si el archivo WSDL hace referencia a otros archivos WSDL o hace referencia a archivos XSD que contienen definiciones de esquema XML, debe crear un archivo .zip del archivo WSDL y sus documentos dependientes y, a continuación, cargar el archivo .zip desde un directorio para añadir la definición de API SOAP.

  • Si utiliza API Designer con las API existentes que se han creado a partir de un archivo WSDL o WSDL.zip en la versión 5 de API Designer, asegúrese de que se cumplen los requisitos siguientes:
    • El archivo WSDL o WSDL.zip debe estar almacenado en el mismo directorio que el archivo YAML de la API.
    • En el archivo YAML de la API, la propiedad x-ibm-configuration -- > wsdl-definition -- > wsdl debe apuntar directamente al archivo WSDL o WSDL.zip sin ninguna vía de acceso especificada (los archivos se encuentran en el mismo directorio).

El servicio debe dar soporte a Web Services Basic Profile Versión 1.1 - Second Edition.

Draft comment: gb042610
Import from URL has been deferred: https://github.ibm.com/velox/ui/issues/5878 JenD Mar2018

Procedimiento

Para añadir una definición de API SOAP cargando un archivo WSDL , realice los pasos siguientes:
  1. En el panel de navegación, haz clic en Icono de desarrollo en el panel de navegación de la interfaz de usuario de la API «Desarrollo » y, a continuación, en «Añadir» > «API ».
    Se visualizará la pantalla Seleccionar tipo de API.
  2. Selecciona OpenAPI 2.0.
  3. Seleccione Desde el servicio WSDL existente (proxy SOAP). Pulse Siguiente.
    Se abre la ventana Crear API a partir de servicio WSDL existente (proxy SOAP).
  4. Para cargar la información del servicio desde un archivo .wsdl independiente o desde un .zip archivo que contenga un archivo WSDL y sus documentos dependientes, puede arrastrar y soltar el archivo, o bien buscar y seleccionar el archivo que desee utilizar.
    Draft comment: gb042610
    There is no option to load from URL yet... so marking these choices as future. JenD Mar2018

    Después de cargar el archivo, se evalúa el WSDL y un mensaje muestra si el WSDL es válido.

    Si carga un archivo .zip, puede incluir en el archivo .zip un archivo de opciones para especificar directivas adicionales. Para obtener más información, consulte «Uso de un archivo de opciones al importar un servicio WSDL ».

  5. Pulse Siguiente. En el panel Seleccionar servicio, seleccione un servicio WSDL del archivo importado.
  6. 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 comandos de la CLI destinados a gestionar las API en borrador, consulta la documentación de referencia de la 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.
  7. 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:
      • CORS El soporte técnico solo está disponible en el 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.
  8. Opcional: Selecciona «Activar API» si deseas utilizarla de inmediato para seguir desarrollando y realizando 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 eliminas la API, el borrador del producto se eliminará junto con ella; consulta Eliminación de una definición de API. El producto es visible en cualquier catálogo en el que se haya publicado. Si desea eliminar un producto de un catálogo, debe hacerlo por separado; consulte «Eliminar 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 puedes utilizar la opción «Activate API» si la aprobación del ciclo de vida está habilitada en el catálogo de Sandbox para las acciones «Stage», «Publish» o «Replace». Si alguna de estas aprobaciones del ciclo de vida está habilitada, para poder utilizar la opción «Activar API» es necesario desactivarlas; para obtener más información sobre la configuración de las aprobaciones del 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.
  9. 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 una URL punto final de API 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.

  10. 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.

Resultados

Ha creado una definición de API SOAP utilizando un archivo WSDL existente.

Qué hacer a continuación

Las APIs quedan a disposición de los desarrolladores de aplicaciones al incluirlas en un producto y publicar después ese producto en un catálogo. Para obtener más información, consulte «Trabajar con productos» y «Trabajar con catálogos ».

También puedes gestionar el ciclo de vida del producto y controlar quién puede ver y suscribirse a tu producto abriendo el catálogo de Sandbox asociado a tu API en la página Icono Gestionar en el panel de navegación de la interfaz de usuario de API Designer «Gestionar» de la interfaz de usuario del Diseñador de API.