Publicación de APIs y aplicaciones

Para publicar API y aplicaciones utilizando el kit de herramientas de desarrollador de IBM® API Connect, establezca las variables de configuración para definir dónde desea publicar, inicie sesión en la plataforma de nube de destino y, a continuación, utilice los mandatos de publicación adecuados.

Consulte las secciones siguientes para obtener más información:

Establecimiento de variables de configuración

El mandato apic config proporciona variables de configuración globales y basadas en proyecto que especifican el catálogo de destino para publicar APIs y aplicaciones. Los valores de estas variables se almacenan en ~/.apiconnect/config (para variables globales) y project-dir/.apiconnect (para variables de proyecto). Para obtener una lista completa de las variables de configuración, consulte Visión general de la herramienta de línea de mandatos.

Establezca la variable de configuración catalog en el URI de un catálogo de API Connect para definir un destino de catálogo predeterminado para todos los mandatos que gestionan catálogos. El URI de catalog tiene el formato:

https://mgmt_endpoint_url/api/catalogs/org_name/catalog_name

donde URL_punto_final_gestión es el URL de punto final de API de plataforma, nombre_org es el nombre de la organización de proveedores y nombre_catálogo es el nombre de catálogo. La parte de url_servidor_gestión establece el valor predeterminado de la opción --server, la parte de nombre_org establece el valor predeterminado de la opción --org y la parte de nombre_catálogo establece el valor predeterminado de la opción --catalog; puede alterar temporalmente cualquiera de estos valores incluyendo la opción correspondiente en un mandato.

Establezca la variable de configuración space en el URI de un API Connect Espacio, para definir un destino Espacio predeterminado para todos los mandatos que gestionan Espacios. El URI de space tiene el formato:
https://mgmt_endpoint_url/api/spaces/org_name/catalog_name/space_name
donde mgmt_endpoint_url es la URL del punto final de la API de la plataforma, org_name es el nombre de la organización proveedora, catalog_name es el nombre del Catálogo y space_name es el nombre del Espacio. La parte URL_punto_final_gestión establece el valor predeterminado de la opción --server, la parte nombre_org establece el valor predeterminado de la opción --org, la parte nombre_catálogo establece el valor predeterminado de la opción --catalog y nombre_espacio establece el valor predeterminado de la opción --space; puede alterar temporalmente cualquiera de estos valores incluyendo la opción correspondiente en un mandato.

Aunque no es necesario establecer estas variables de configuración, hacerlo simplifica los mandatos que interactúan con nubes de API Connect proporcionando valores predeterminados para las opciones de línea de mandatos utilizadas con frecuencia.

A continuación se proporciona un ejemplo de publicación con y sin la variable de configuración catalog establecida.

Sin la variable de configuración establecida:

apic products publish climb-on.yaml --server mgmnthost.com --org climbon --catalog sandbox

Con la variable de configuración establecida:

apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
catalog: https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic products publish climb-on.yaml

Puede alterar temporalmente los valores proporcionados por la variable de configuración catalog proporcionando una de las opciones estándar con un valor diferente. Por ejemplo, utilice la opción --catalog con el mandato apic products publish para especificar el catálogo qa:

 apic products publish climb-on.yaml --catalog qa

No se olvide de las variables de configuración globales. Si utiliza el mismo catálogo que el destino predeterminado para varios proyectos, establezca el valor globalmente:

 apic config:set --global catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
Nota:

Si tiene una variable de entorno con el mismo nombre que una propiedad de configuración de la CLI, de forma predeterminada, su valor alterará temporalmente el valor de la propiedad de configuración de la CLI correspondiente para cualquier mandato de CLI de ese ámbito.

Por ejemplo, si ha definido una variable de entorno denominada SPACE, de forma predeterminada, se asumirá ese valor para el valor del parámetro --space en el mandato siguiente, independientemente de cualquier valor de propiedad de configuración space:
apic products:publish my_product.yaml --scope space

Para evitar que las variables de entorno alteren temporalmente las propiedades de configuración de la CLI, defina una variable de entorno denominada APIC_LOAD_FROM_ENV, establecida en el valor false.

Inicio de sesión en API Connect

Utilice los mandatos apic login y apic logout para gestionar la autenticación Para más detalles, consulte rapic_cli_login.html.

Publicación de APIs

La publicación de API en catálogos de API en API Connect la nube le permite socializar las API mediante el portal para desarrolladores y protegerlas mediante la puerta de enlace.

Se utiliza un Producto de API (o simplemente un Producto) para componer APIs para la publicación. Los gestores de productos API pueden utilizarlo para agrupar una o varias API, controlar la visibilidad del producto en el portal para desarrolladores (por ejemplo, permitir solo a los socios x, y y z ver y suscribirse al producto) y definir planes para ofrecer opciones de consumo. Los productos que hacen referencia a las APIs y definen los planes de consumo también son la unidad primaria de gestión de ciclo de vida para las APIs.

Utilice el mandato apic products publish (equivalente a apic products:publish) para publicar productos de API en una nube de API Connect . El ejemplo siguiente muestra cómo crear APIs compuestas por un producto y cómo publicar el producto y las APIs correspondientes en un catálogo:

apic create:api --title Routes
apic create:api --title Ascents
apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml"
apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic login --username some-user --password some-password --server platform-api.myserver.com --realm provider/default-idp-2
apic products publish climb-on.yaml

Para obtener información detallada sobre cómo iniciar sesión en el servidor de gestión desde la CLI, consulte Inicio de sesión en un servidor de gestión.

Añada la opción --stage a apic publish para desplegar el producto en un catálogo en lugar de publicarlo. Los productos de un catálogo pueden tener los estados siguientes: desplegado, publicado, en desuso o retirado. Por ejemplo:

apic products publish --stage climb-on.yaml

Puede utilizar un espacio para particionar un catálogo de modo que varios equipos puedan gestionar productos y APIs independientemente en un solo catálogo. Un espacio es conceptualmente similar a un subcatálogo, salvo que los productos y las API de todos los espacios de un catálogo se publican en el mismo portal para desarrolladores. Para obtener más información sobre Spaces, consulte Uso de la sindicación en IBM API Connect.

Si se han establecido valores de configuración predeterminados para el Espacio, Catálogo, organización y servidor de gestión, se podría utilizar el siguiente mandato de publicación:
apic products publish --scope space product.yaml
donde producto es el nombre del producto que desea publicar.
Nota: Si el archivo OpenAPI que define la API utiliza un campo $ref para hacer referencia a un fragmento de código OpenAPI 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 con el mandato apic publish . Para obtener más información, consulte Utilización de $ref para reutilizar fragmentos de código en los archivos OpenAPI.