Esercitazione: Usare le revisioni per apportare nell'API modifiche che non causano un'interruzione in modo sicuro
SI APPLICA A: Tutti i livelli di Gestione API
Quando l'API è pronta per l'uso e viene usata dagli sviluppatori, è infine necessario apportare modifiche a tale API e allo stesso tempo non interrompere i chiamanti dell'API. È anche utile informare gli sviluppatori delle modifiche apportate.
In Gestione API di Azure è possibile usare le revisioni per apportare modifiche che non causano un'interruzione alle API al fine di modellare e testare le modifiche in modo sicuro. Quando si è pronti, è sufficiente impostare una revisione come corrente e sostituire l'API in uso.
Per i concetti di base, vedere Versioni e revisioni e Controllo delle versioni delle API con Gestione API di Azure.
In questa esercitazione apprenderai a:
- Aggiungere una nuova revisione
- Apportare modifiche non di rilievo alla revisione
- Rendere la revisione corrente e aggiungere una voce del registro modifiche
- Esplorare il portale per sviluppatori per visualizzare le modifiche e il registro modifiche
Prerequisiti
- Acquisire familiarità con la terminologia di Gestione API di Azure.
- Completare la guida introduttiva seguente: Creare un'istanza di Gestione API di Azure.
- Completare anche l'esercitazione seguente: Importare e pubblicare la prima API.
Aggiungere una nuova revisione
Accedere al portale di Azure e passare all'istanza di Gestione API.
Selezionare API.
Selezionare Demo Conference API nell'elenco di API oppure l'API a cui si vuole aggiungere le revisioni.
Selezionare la scheda Revisioni.
Selezionare + Aggiungi revisione.
Suggerimento
È anche possibile scegliere Aggiungi revisione nel menu di scelta rapida (...) dell'API.
Fornire una descrizione per la nuova revisione, per ricordarsi per che cosa verrà usato.
Seleziona Crea.
La nuova revisione è stata creata.
Nota
L'API originale resta nella Revisione 1. Si tratta della revisione che gli utenti continueranno a chiamare fino a quando non si imposta come corrente una revisione diversa.
Apportare modifiche non di rilievo alla revisione
Selezionare Demo Conference API (API Demo Conference) nell'elenco di API.
Selezionare la scheda Progettazione nella parte superiore della schermata.
Si noti che il selettore di revisione (appena sopra la scheda Progettazione) mostra la revisione corrente come Revisione 2.
Suggerimento
Usare il selettore di revisione per alternare le revisioni su cui si intende lavorare.
Selezionare + Aggiungi operazione.
Impostare la nuova operazione su POST, e il nome, il nome visualizzato e l'URL dell'operazione come test.
Salvare la nuova operazione.
È stata ora apportata una modifica alla Revisione 2. Usare il selettore di revisione nella parte superiore della pagina per tornare alla Revisione 1.
Si noti che la nuova operazione non viene visualizzata in revisione 1.
Rendere la revisione corrente e aggiungere una voce del registro modifiche
Selezionare la scheda Revisioni dal menu nella parte superiore della pagina.
Aprire il menu di scelta rapida (...) per la Revisione 2.
Selezionare Imposta come corrente.
Selezionare Post to Public Change Log for this API(Pubblica nel log delle modifiche pubblico per questa API) per pubblicare delle note sulla modifica. Fornire una descrizione per la modifica che gli sviluppatori possono visualizzare, ad esempio: revisioni di test. Aggiunta una nuova operazione "test".
La Revisione 2 è ora quella corrente.
Esplorare il portale per sviluppatori per visualizzare le modifiche e il registro modifiche
Nel portale per sviluppatori, è possibile esaminare le modifiche apportate all'API e il log delle modifiche.
- Nel portale di Azure selezionare API.
- Selezionare Portale per sviluppatori dal menu in alto.
- Nel portale per sviluppatori selezionare API, quindi Demo Conference API.
- Si noti che è ora disponibile la nuova operazione test.
- Fare clic su Log delle modifiche accanto al nome dell'API.
- Si noti che il registro modifiche è ora visualizzato nell’elenco.
Passaggi successivi
Questa esercitazione ha descritto come:
- Aggiungere una nuova revisione
- Apportare modifiche non di rilievo alla revisione
- Rendere la revisione corrente e aggiungere una voce del registro modifiche
- Esplorare il portale per sviluppatori per visualizzare le modifiche e il registro modifiche
Passare all'esercitazione successiva: