Gestione dei prodotti API

Utilizzo dei comandi products e apis attraverso un ciclo di vita completo

Questo esempio mostra un ciclo di vita complesso in cui una nuova versione di un prodotto e di un'API sostituisce la versione originale al runtime.

Imposta il catalogo predefinito ed effettua l'accesso al cloud API Connectmgmnthost.com

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

Per i dettagli completi su come accedere al tuo server di gestione dalla CLI, vedi Accesso al server di gestione.

Crea e pubblica una versione iniziale

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

Crea una nuova versione per correggere un bug nell'API, preparalo al catalogo

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

Esamina il catalogo

apic products:list-all --scope catalog

Questo comando elenca tutti i prodotti presenti nel catalogo. Copiare l'ID del prodotto climbon:1.0.1 . L'ID è simile al seguente esempio.

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

Crea un file di associazione

Ad esempio, se si sostituisce un prodotto, il file di mappatura specifica il prodotto da sostituire e mappa i piani dal prodotto di origine al prodotto di destinazione. Ad esempio, se si sta sostituendo climbon:1.0.0 con climbon:1.0.1 , la proprietà product_url specifica l' URL e di climbon:1.0.0.

Questo file ha il modulo seguente:

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:

• I nomi del piano di origine e di destinazione possono essere uguali o diversi.
• Ogni piano nel prodotto che si sta sostituendo deve essere associato a un piano nel prodotto di sostituzione.

"Hot-replace" versione 1.0.0 con 1.0.1

apic products:replace climbon:1.0.1 PRODUCT_PLAN_MAPPING_FILE

Una volta sostituito in questo modo, il prodotto indicato viene ritirato dal mercato. Non è più attivo.

Nota:

Il prodotto indicato nel comando è il prodotto sostitutivo. Ad esempio, se si sostituisce climbon:1.0.0 con climbon:1.0.1 , il prodotto specificato nel comando è climbon:1.0.1.

Sostituire la versione 1.0.0 con 1.0.1

Invece di sostituire a sistema acceso un prodotto esistente con uno nuovo (di norma una versione aggiornata), è possibile sostituire il prodotto esistente con uno nuovo. Quando si sostituisce un prodotto, tutte le sottoscrizioni dell'applicazione esterna a tale prodotto vengono automaticamente spostate nel nuovo prodotto. Quando si sostituisce un prodotto, le sottoscrizioni non vengono automaticamente spostate nel nuovo prodotto, è necessaria un'azione per sottoscrivere le applicazioni esterne al prodotto sostitutivo.

Il comando per sostituire un prodotto utilizza lo stesso file di associazione del comando per sostituire un prodotto. Il nome del prodotto sostitutivo è indicato nel comando.

apic products:supersede climbon:1.0.1 PRODUCT_PLAN_MAPPING_FILE

Una volta che un prodotto è stato sostituito, viene contrassegnato come "obsoleto", il che significa che non è più possibile sottoscrivere nuovi abbonamenti a tale prodotto, sebbene esso rimanga attivo e gli abbonamenti esistenti continuino a funzionare.

Nota: il prodotto indicato nel comando è quello che sostituisce il precedente. Ad esempio, se si sostituisce climbon:1.0.0 con climbon:1.0.1 , il prodotto specificato nel comando è climbon:1.0.1. Il file di mappatura specifica l' URL e del prodotto che si sta sostituendo.

Imposta una destinazione di migrazione

È possibile impostare una destinazione di migrazione per il prodotto esistente. Ciò consente la migrazione.

Utilizzare un comando simile al seguente per impostare la destinazione della migrazione.

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

Nota: il prodotto specificato nel comando è quello dal quale si desidera trasferire gli abbonamenti. Il file di associazione specifica il prodotto di destinazione per le sottoscrizioni.

Una volta definita una destinazione di migrazione, gli sviluppatori di applicazioni esterne possono migrare facilmente i propri abbonamenti alle applicazioni tramite il Catalogo dei consumatori. È inoltre possibile eseguire una migrazione degli abbonamenti utilizzando il seguente comando.

apic products:execute-migration-target climbon:1.0.0

Elimina un prodotto

Quando il prodotto sostituito o sostituito non è più necessario, può essere eliminato.

apic products:delete climbon:1.0.0