Gestión de productos de API

Utilización de los mandatos products y apis a lo largo de un ciclo de vida completo

Este ejemplo muestra un ciclo de vida complejo en el que una nueva versión de un producto y API sustituye a la versión original en tiempo de ejecución.

Establezca el Catálogo por defecto e inicie sesión en la nube mgmnthost.com ' API Connect

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 my-identity-provider

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

Crear y publicar una versión inicial

apic create:api --title Routes --version 1.0.0 --filename routes100.yaml
apic create:product --title "Climb On" --version 1.0.0 --apis routes100.yaml --filename climbon100.yaml
apic products:publish climbon100.yaml

Crear una versión para solucionar un error en la API, desplegarla en el catálogo

apic create:api --title Routes --version 1.0.1 --filename routes101.yaml
apic create:product --title "Climb On" --version 1.0.1 --apis routes101.yaml --filename climbon101.yaml
apic products:publish --stage climbon101.yaml

Inspeccionar el catálogo

apic products:list-all --scope catalog

Este comando lista todos los Productos del catálogo. Copie el ID del producto climbon:1.0.1. El ID es similar al del ejemplo siguiente.

https:/server/api/catalogs/3eca6046-3c27-4ad/ab8772bf-0f65-45/products/8f854623-bda1-4f9

Crear un archivo de correlaciones

Por ejemplo, si reemplaza un Producto, el archivo de asignación especifica el Producto a reemplazar y asigna los Planes del Producto de origen al Producto de destino. Por ejemplo, si está sustituyendo climbon:1.0.0 por climbon:1.0.1, la propiedad product_url especifica el URL de climbon:1.0.0.

Este archivo tiene el formato siguiente:

product_url: https:/server/api/catalogs/{id}/products/{id}
plans:
- source: {source_plan_name_1}
  target: {target_plan_name_1}
- source: {source_plan_name_2}
  target: {target_plan_name_2}
            .
            .
            .

Nota:

• Los nombres de los planes de origen y destino pueden ser iguales o diferentes.
• Cada plan del producto que está sustituyendo debe estar correlacionado con un plan del producto de sustitución.

Sustitución en caliente de la versión 1.0.0 por la 1.0.1

apic products:replace climbon:1.0.1 PRODUCT_PLAN_MAPPING_FILE

Una vez sustituido de este modo, un Producto especificado se da de baja. Ya no estará activo.

Nota:

El Producto especificado en el comando es el Producto de sustitución. Por ejemplo, si sustituye climbon:1.0.0 por climbon:1.0.1 , el producto especificado en el comando será climbon:1.0.1.

Reemplazar la versión 1.0.0 por la 1.0.1

En lugar de sustituir en caliente un producto existente por uno nuevo, (generalmente una versión actualizada), puede reemplazar el producto existente por uno nuevo. Al sustituir un producto, todas las suscripciones de aplicaciones externas a dicho producto se trasladan automáticamente al producto nuevo. Al reemplazar un producto, las suscripciones no se trasladan automáticamente al producto nuevo; debe realizarse alguna acción para suscribir las aplicaciones externas al producto de reemplazo.

El mandato para reemplazar un producto utiliza el mismo archivo de correlaciones que el mandato para sustituir un producto. El nombre del Producto sustituto se indica en la orden.

apic products:supersede climbon:1.0.1 PRODUCT_PLAN_MAPPING_FILE

Una vez sustituido un Producto, éste se marca como obsoleto, lo que significa que no se permiten más suscripciones al Producto, aunque sigue activo y las suscripciones existentes siguen funcionando.

Nota: El Producto especificado en el comando es el Producto reemplazante. Por ejemplo, si sustituye climbon:1.0.0 por climbon:1.0.1 , el producto especificado en el comando será climbon:1.0.1. El archivo de asignación especifica la dirección URL del Producto que está sustituyendo.

Establecer un destino de migración

Es posible establecer un destino de migración para el producto existente. Esto ayuda en la migración.

Utilice un mandato como el siguiente para establecer el destino de la migración.

apic products:set-migration-target climbon:1.0.0 PRODUCT_PLAN_MAPPING_FILE

Nota: El Producto que se especifica en el comando es el Producto del que desea migrar las suscripciones. El archivo de correlaciones especifica el producto de destino para las suscripciones.

Una vez establecido un objetivo de migración, los desarrolladores de aplicaciones externas pueden migrar sus suscripciones de aplicaciones a través del Portal del Desarrollador con facilidad. También es posible ejecutar una migración de suscripción utilizando el siguiente comando.

apic products:execute-migration-target climbon:1.0.0

Suprimir un producto

Cuando el producto sustituido o reemplazado ya no es necesario, puede suprimirse.

apic products:delete climbon:1.0.0