Questa pagina si applica a Apigee e Apigee ibridi.
Questo argomento spiega cosa devi sapere sulla creazione e sulla gestione delle versioni nell'hub API.
Che cos'è una versione?
A ogni risorsa API nell'hub API è associata almeno una versione. Puoi pensare a lo stato di un'API in un determinato momento. In pratica, le versioni ti aiutano a raggruppare organizzare le API in base a insiemi di operazioni, deployment e altri attributi sottostanti.
Nell'hub API, una versione rappresenta un raggruppamento logico di API. Di solito, ma non necessariamente, questo Il raggruppamento ruota attorno alle operazioni che un'API può eseguire. Ad esempio, supponiamo che tu abbia un'API Pet Store e la prima versione di questa API ti consente di eseguire attività di base, come aggiungere un animale domestico, alla ricerca di un animale domestico ed eliminazione di un animale domestico dal negozio. Questi sono esempi di operazioni.
È buona norma che una versione includa un set di operazioni API di cui viene eseguito il deployment in sinergia. Ad esempio, un'API del negozio di animali potrebbe avere una versione che include add, Find e operazioni di eliminazione, di cui è stato eseguito il deployment negli stessi ambienti.
Un altro buon modo di pensare a una versione è che rappresenta il punto di vista del producer dell'API. È l'insieme di funzionalità e funzionalità che le persone che hanno creato l'API vi hanno messo e si aspettano di eseguirne il deployment .
Creazione delle versioni in corso...
Supponiamo che i dettagli di un'API che vuoi aggiungere all'hub API vengano acquisiti in una specifica OpenAPI. In tal caso, puoi aggiungere le specifiche a una versione API. In questo caso, l'hub API analizza la specifica, estrae informazioni da quest'ultima, ad esempio le operazioni incluse nell'API, informazioni con la versione. Se non disponi di una specifica OpenAPI, puoi comunque creare una versione, ma devi per compilarlo manualmente con le informazioni descrittive pertinenti. Un altro caso in cui l'hub API supporta l'analisi dei dettagli delle 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 vengono aggiunte nuove operazioni a un'API, potrebbe esigere la creazione di una nuova versione oppure forse no.
Supponiamo che il producer di API aggiunga una nuova operazione a un'API e ne intenda il deployment in tutti dei 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 fa una relazione arretrata una modifica incompatibile (una modifica che provoca un errore) e sceglie di associarla a un nuovo deployment, potresti voler creare una nuova versione.
Come puoi notare, l'hub API offre la flessibilità necessaria per definire e organizzare le versioni API più adatti 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 con questi attributi nelle Impostazioni. Per maggiori dettagli, vedi Gestire gli attributi.
| Attributo | Descrizione |
|---|---|
| Fase del ciclo di vita dell'API | Il ciclo di vita si riferisce a un insieme ordinato di fasi un'API deve progredire, dall'ideazione alla fine del ciclo di vita. Poiché ogni versione di un'API di solito segue il proprio ciclo di vita separatamente e non lo impostiamo direttamente di un'API, ma assegna a ciascuna versione una fase del ciclo di vita. |
| Documentazione | Un link alla documentazione per l'API a cui è allegata la versione. |
| Conformità | Tramite le impostazioni, puoi definire i valori che rappresentano la conformità dettagli di interesse per il tuo team o la tua organizzazione. Per maggiori dettagli, vedi Gestire gli attributi. |
| Accreditamento | Tramite le Impostazioni, puoi definire i valori rappresentano i dettagli sull'accreditamento di interesse per il tuo team o la tua organizzazione. Per maggiori dettagli, vedi Gestire gli attributi. |
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.