Questa pagina si applica ad Apigee e Apigee hybrid.
Questo argomento spiega cosa devi sapere sulla creazione e sulla gestione delle versioni in API Hub.
Che cos'è una versione?
A ogni risorsa API nell'hub API è associata almeno una versione. Puoi pensare a una versione come allo stato di un'API in un determinato momento. Fondamentalmente, le versioni ti consentono di raggruppare e organizzare le API in base a insiemi sottostanti di operazioni, implementazioni, specifiche e altri attributi, come mostrato nella Figura 1.
Figura 1. Ogni versione può avere operazioni, implementazioni e altri attributi.
In API Hub, una versione rappresenta un raggruppamento logico di API. In genere, ma non necessariamente, questo raggruppamento ruota attorno alle operazioni che un'API può eseguire. Ad esempio, supponiamo che tu abbia un'API per negozi di animali domestici e che la prima versione di questa API ti consenta di eseguire attività di base, come aggiungere un animale domestico, trovarne uno ed eliminarlo dal negozio. Questi sono esempi di operazioni.
È buona prassi che una versione includa un insieme di operazioni dell'API di cui viene eseguito il deployment insieme. Ad esempio, un'API di un negozio di animali domestici potrebbe avere una versione che include operazioni di aggiunta, ricerca ed eliminazione, tutte implementate negli stessi ambienti.
Un altro modo utile per considerare una versione è che rappresenta la visione dell'API del produttore dell'API. Si tratta della raccolta di funzionalità e funzionalità che le persone che hanno creato l'API hanno inserito e che si aspettano di implementare con l'API.
Creazione di versioni
Supponiamo che i dettagli di un'API che vuoi aggiungere all'hub API siano acquisiti in una specifica OpenAPI. In questo caso, puoi aggiungere la specifica a una versione dell'API. In questo caso, l'hub API analizza la specifica e ne estrae le informazioni, ad esempio le operazioni incluse nell'API, e le memorizza con la versione. Se non disponi di una specifica OpenAPI, puoi comunque creare una versione, ma dovrai completarla manualmente con informazioni descrittive pertinenti. Un altro caso in cui l'hub API supporta l'analisi dei dettagli dell'API tramite la registrazione automatica dei proxy API Apigee.
Puoi caricare più file di specifiche dell'API nella stessa versione.
Quando creare una nuova versione?
Se a un'API vengono aggiunte nuove operazioni, potrebbe essere necessario creare una nuova versione, ma forse no.
Supponiamo che il produttore dell'API aggiunga una nuova operazione a un'API e intenda che venga eseguita il deployment in tutti i deployment attualmente associati alla versione. In questo caso, il produttore può scegliere di non creare una nuova versione dell'API. D'altra parte, se il produttore apporta una modifica non compatibile con le versioni precedenti (una modifica che comporta una rottura) e sceglie di associarla a un nuovo deployment, potresti voler creare una nuova versione.
L'hub API ti offre la flessibilità di definire e organizzare le versioni delle API in base alle esigenze della tua organizzazione e a quelle di produttori di API specifici.
Attributi di sistema
Per impostazione predefinita, le versioni includono i seguenti attributi di sistema. Puoi modificare i valori associati a questi attributi nelle Impostazioni. Per maggiori dettagli, vedi Gestire gli attributi.
| Attributo | Descrizione |
|---|---|
| Ciclo di vita | Per ciclo di vita si intende un insieme ordinato di fasi che deve essere completato da un'API, dalla progettazione al ritiro. Poiché ogni versione di un'API solitamente attraversa il proprio ciclo di vita separatamente, non impostiamo direttamente la fase del ciclo di vita di un'API, ma consentiamo a ogni versione di avere una fase del ciclo di vita assegnata. |
| Conformità | In Impostazioni, puoi definire i valori per rappresentare i dettagli relativi alla conformità di interesse per il tuo team o la tua organizzazione. Per maggiori dettagli, vedi Gestire gli attributi. |
| Accreditamento | In Impostazioni, puoi definire i valori per rappresentare i dettagli dell'accreditamento di interesse per il tuo team o la tua organizzazione. Per maggiori dettagli, vedi Gestire gli attributi. |
| Documentazione | Un link alla documentazione dell'API a cui è associata la versione. |
Attributi definiti dall'utente
A seconda delle esigenze del team o dell'organizzazione, puoi definire attributi personalizzati (coppie nome/valore) per le versioni. Vedi Gestire gli attributi.