Puntos finales REST para distribuir API en IBM API Connect
Utilice el punto final REST, que es una ubicación central para que tanto los usuarios internos, como los usuarios de Cloud Liberty, visualicen, llamen y distribuyan API en IBM® API Connect.
Distribución de puntos finales REST desplegados en IBM API Connect
Para distribuir puntos finales REST desplegados en IBM API Connect, debe llamar a un nuevo punto final REST, /ibm/api/docs/apiconnect, que se expone mediante la característica apiDiscovery-1.0 en la configuración del servidor. Los administradores y desarrolladores pueden utilizar los puntos finales REST para exponer activos de una instancia de Liberty a cualquier desarrollador empresarial que esté buscando en los catálogos de marcos de trabajo de IBM API Connect.
Proporcionar una definición del producto
Todas las API están referenciadas mediante un producto y expuestas en un catálogo. Por lo tanto, el interlocutor proporciona una definición de producto que Liberty utiliza para hacer referencia a sus API RESTful y distribuir el producto resultante en IBM API Connect. Se proporciona un producto de ejemplo en este tema.
Exposición de activos de un colectivo Liberty en IBM API Connect
Utilizando un punto final de colectivo Liberty correspondiente, /ibm/api/collective/docs/apiconnect, puede exponer todos los activos de un colectivo Liberty en IBM API Connect con un solo desencadenante RESTful. El punto final del colectivo Liberty puede exponer miles de API a cualquier desarrollador de nubes conectado a API Connect. Consulte el registro de API RESTful de Liberty, /ibm/api/explorer, para ver la definición completa de Swagger de este punto final.
Resumen de punto final
Método de solicitud HTTP: POST
URL: https://servidor:puerto_https/ibm/api/docs/apiconnect
Cabeceras necesarias
- X-APIM-Authorization
- Las credenciales para conectarse a API
Connect se muestran en los dos formatos siguientes:
- nombre_usuario y contraseña
- xyz donde xyz es la versión codificada en base64 de nombre de usuario : contraseña.
Parámetros de consulta necesarios
- Servidor
- El nombre del servidor IBM API Connect, empezando por https://.
- Catálogo
- El nombre del catálogo que aloja el producto resultante.
- Organización
- El nombre de la organización del interlocutor.
Parámetros de consulta opcionales
- apiRoot
- Un parámetro de cardinalidad múltiple que especifica exactamente qué raíces de contexto, como, apiRoot=/myApp, desea distribuir el interlocutor en API Connect. De forma predeterminada, Liberty incluye cualquier aplicación desplegada, excepto los paquetes de aplicaciones web de tiempo de ejecución Liberty conocidos. Este parámetro es útil si se desea filtrar qué aplicaciones se van a exponer.
- ID de miembro (solo disponible para la variante Collective)
- Un parámetro de cardinalidad múltiple que especifica el ID de los miembros exactos del colectivo de los cuales el interlocutor desea exponer activos. Este ID está formado por una serie con el nombre de host, the URLEncoded user dir, y el nombre de servidor, todo separado con una coma, por ejemplo myHost.com, %2Ftmp%2Fwlp%2Fusr, server1.
- Cuerpo de entrada
- Definición de producto en código YAML o JSON. Consulte el
ejemplo de YAML siguiente:
product: "1.0.0" info: name: "pushed-product" title: "Un producto que encapsulat API Liberty" version: "1.0.0" visibility: view: enabled: true type: "public" tags: - "string" orgs: - "string" subscribe: enabled: true type: "authenticated" tags: - "string" orgs: - "string" apis: liberty: name: "liberty-api:1.0.0" x-ibm-configuration: phase: "realized" testable: true enforced: true cors: enabled: true assembly: execute: - invoke: target-url: "${gateway.target}" title: "Invocación" description: "Invocación de servicio de fondo" plans: valor predeterminado: title: "Plan predeterminado" rate-limit: hard-limit: false value: "100/hour" approval: false createdAt: "2016-04-18T20:33:22.937Z" createdBy: "string"