Pubblicazione di API e applicazioni

Modifica online

Per pubblicare le API e le applicazioni utilizzando il toolkit sviluppatori di IBM® API ConnectAI Gateway, è necessario impostare le variabili di configurazione per definire dove si desidera pubblicare, accedere alla piattaforma cloud di destinazione e quindi utilizzare i comandi di pubblicazione appropriati.

Per ulteriori informazioni, consulta la seguenti sezioni:

Impostazione delle variabili di configurazione

Il comando apic config fornisce variabili di configurazione globali e basate su progetti che specificano il catalogo di destinazione per la pubblicazione di applicazioni e API. I valori di queste variabili sono memorizzati in ~/.apiconnect/config (per le variabili globali) e project-dir/.apiconnect (per le variabili di progetto). Per un elenco completo delle variabili di configurazione, consultare la panoramica dello strumento da riga di comando.

Impostare la variabile di configurazione catalog sull'URI di un catalogo API ConnectAI Gateway per definire una destinazione di catalogo predefinita per tutti i comandi che gestiscono cataloghi. L'URI catalog ha il formato:

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

dove mgmt_endpoint_url è l' URL dell'endpoint API della piattaforma, org_name è il nome dell'organizzazione del provider e catalog_name è il nome del catalogo. La parte mgmt_endpoint_url imposta il valore predefinito dell'opzione --server , la porzione nome_organizzazione imposta il valore predefinito dell'opzione --org e la parte nome_catalogo imposta il valore predefinito dell'opzione --catalog ; è possibile sovrascrivere uno qualsiasi di questi valori includendo l'opzione corrispondente in un comando.

Impostare la variabile di configurazione space sull'URI di un API ConnectAI Gateway Spazio, per definire una destinazione Spazio predefinita per tutti i comandi che gestiscono Spazi. L'URI space ha il formato:
https://mgmt_endpoint_url/api/spaces/org_name/catalog_name/space_name
dove mgmt_endpoint_url è l' URL dell'endpoint API della piattaforma, org_name è il nome dell'organizzazione del provider, catalog_name è il nome del catalogo e space_name è il nome dello spazio. La parte mgmt_endpoint_url imposta il valore predefinito dell'opzione --server , la porzione org_name imposta il valore predefinito dell'opzione --org , la porzione catalog_name imposta il valore predefinito dell'opzione --catalog e space_name imposta il valore predefinito dell'opzione --space ; è possibile sovrascrivere uno qualsiasi di questi valori includendo l'opzione corrispondente in un comando.

Anche se l'impostazione di queste variabili di configurazione non è richiesta, questa operazione semplifica i comandi che interagiscono con i cloud API ConnectAI Gateway fornendo valori predefiniti per le opzioni della riga di comando utilizzate di frequente.

Di seguito è riportato un esempio di pubblicazione con e senza la variabile di configurazione catalog impostata.

Senza la variabile di configurazione impostata:

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

Con la variabile di configurazione impostata:

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

È possibile sovrascrivere i valori predefiniti forniti dalla variabile di configurazione catalog fornendo una delle opzioni standard con un valore diverso. Ad esempio, utilizzare l'opzione --catalog con il comando apic products publish per specificare il catalogo qa :

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

Non dimenticare le variabili di configurazione globali. Se si utilizza lo stesso catalogo come destinazione predefinita per più progetti, impostare il valore globalmente:

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

Se hai una variabile di ambiente con lo stesso nome di una proprietà di configurazione CLI, per impostazione predefinita, il suo valore sovrascriverà il valore della proprietà di configurazione CLI corrispondente per qualsiasi comando CLI in tale ambito.

Ad esempio, se è stata definita una variabile di ambiente denominata SPACE , per impostazione predefinita, tale valore verrà assunto per il valore del parametro --space nel seguente comando, indipendentemente da qualsiasi impostazione della proprietà di configurazione space :
apic products:publish my_product.yaml --scope space

Per impedire alle variabili di ambiente di sovrascrivere le proprietà di configurazione della CLI, definisci una variabile di ambiente denominata APIC_LOAD_FROM_ENV, impostata sul valore false.

Accesso a API ConnectAI Gateway

Utilizzare i comandi apic login e apic logout per gestire l'autenticazione. Per ulteriori informazioni, consultare il sito rapic_cli_login.html.

Pubblicazione di API

La pubblicazione delle API nei cataloghi API dei API ConnectAI Gateway cloud consente di renderle accessibili al pubblico tramite il Catalogo dei consumatori del Portale per gli sviluppatori e di proteggerle tramite il Gateway.

Un Prodotto API (o semplicemente Prodotto) viene utilizzato per comporre le API per la pubblicazione. I responsabili dei prodotti API possono utilizzarlo per raggruppare una o più API, controllare la visibilità del prodotto nel catalogo dei consumatori del portale per sviluppatori (ad esempio, consentire solo ai partner x, y e z di visualizzare e sottoscrivere il prodotto) e definire piani per offrire diverse opzioni di utilizzo. I prodotti che fanno riferimento alle API e definiscono i piani di utilizzo sono anche l'unità principale di gestione del ciclo di vita delle API.

Utilizza il comando apic products publish (equivalente a apic products:publish) per pubblicare i Prodotti API in un cloud API ConnectAI Gateway . Il seguente esempio mostra come creare le API composte da un prodotto e come pubblicare il prodotto e le relative API in un catalogo:

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

Per informazioni complete su come accedere al server di gestione tramite l'interfaccia CLI, consultare la sezione "Accesso a un server di gestione".

Aggiungere l'opzione --stage a apic publish per preparare il Prodotto in un catalogo invece di pubblicarlo. I prodotti in un catalogo possono essere nei seguenti stati: in staging, pubblicati, obsoleti o ritirati. Ad esempio:

apic products publish --stage climb-on.yaml

Puoi utilizzare uno Spazio per suddividere in partizioni un catalogo in modo che più team possano gestire i Prodotti e le API in modo indipendente in un singolo catalogo. Uno "Spazio" è concettualmente simile a un sottocatalogo, con la differenza che i prodotti e le API presenti in tutti gli spazi all'interno di un catalogo vengono pubblicati nello stesso Catalogo consumatori del Portale sviluppatori. Per ulteriori informazioni su Spaces, consultare la sezione "Utilizzo della syndication" all'indirizzo IBMAPI ConnectAI Gateway.

Se i valori di configurazione predefiniti sono stati impostati per Spazio, Catalogo, organizzazione e server di gestione, è possibile utilizzare il seguente comando di pubblicazione:
apic products publish --scope space product.yaml
dove prodotto è il nome del prodotto che si desidera pubblicare.
Nota: se il file OpenAPI che definisce la tua API utilizza un campo $ref per fare riferimento a un frammento di codice OpenAPI definito in un file separato, il campo $ref viene sostituito con il contenuto del file di destinazione prima che il prodotto che contiene l'API venga preparato o pubblicato con il comando apic publish . Per ulteriori informazioni, vedi Utilizzo di $ref per riutilizzare i frammenti di codice nei tuoi file OpenAPI.