Gestione del controllo delle versioni dell'API

Questa pagina descrive come eseguire il controllo delle versioni per la tua API e come eseguire il deployment su più versioni.

Suggerimenti per la gestione delle versioni dell'API

Quando gestisci le versioni dell'API, tieni presente questi suggerimenti:

  • Quando vuoi introdurre una modifica incrementale, ma non distruttiva, mantieni la versione dell'API costante ed esegui il deployment sull'API esistente.
  • Quando introduci una modifica che provoca un errore nell'API, incrementa la versione dell'API.
  • Per una protezione aggiuntiva, incrementa anche la versione dell'applicazione App Engine, quindi esegui il deployment della nuova versione dell'API in questa nuova versione dell'applicazione App Engine. In questo modo puoi utilizzare la flessibilità integrata di App Engine per passare rapidamente da una versione all'altra di App Engine e pubblicare dalle versioni precedenti funzionanti in caso di problemi imprevisti.

La tabella seguente è un'illustrazione delle versioni dell'API di backend in cascata per diverse versioni dell'applicazione App Engine.

Versione dell'applicazione Versione dell'API di backend
1
  • v1 --> v1 (2) --> v1 (n)
2
  • v1 (n)
  • v2 --> v2 (2) --> v2 (n)
3
  • v1 (n)
  • v2 (n)
  • v3 --> v3 (2) --> v3 (n)

Come mostrato nella tabella, vengono implementati aggiornamenti incrementali e non distruttivi alla versione 1 dell'API, ognuno dei quali sovrascrive la versione precedente. Quando vengono introdotte modifiche che causano interruzioni, la versione dell'API viene incrementata a v2 e viene eseguito il deployment in una nuova versione dell'applicazione App Engine. In questo modo, se necessario, potrai tornare alla versione precedente delle applicazioni.

Nella tabella, nota che la versione 2 dell'applicazione supporta sia l'ultima versione v1 sia la nuova versione v2 dell'API. Se non elimini il codice v1 esistente dal tuo progetto, quando lo implementi sia v2 che vl (n) della tua API vengono implementati nella versione 2 della tua applicazione.

Deployment su più versioni dell'applicazione

Quando esegui il deployment dell'API di backend, lo fai nell'ID progetto del progettoGoogle Cloud che hai creato per l'API e devi anche specificare la versione di App Engine in cui esegui il deployment. Specifichi la versione dell'app App Engine nella riga di comando quando esegui il deployment dell'app. La versione dell'app App Engine non corrisponde al numero di versione dell'API di backend, che specifichi nell'argomento version del decoratore @endpoints.api.

apiversions-python

Come mostrato nella figura precedente, puoi eseguire il deployment di più versioni dell'API nella stessa versione di App Engine. Inoltre, puoi avere molte versioni di App Engine per un'applicazione.

Accesso alle versioni API di cui è stato eseguito il deployment in una versione di pubblicazione

La prima versione di App Engine in cui esegui il deployment dell'API è la versione di pubblicazione. Questa versione viene eseguita all'URL http://YOUR_PROJECT_ID.appspot.com, dove YOUR_PROJECT_ID rappresenta l'ID progetto Google Cloud. Puoi accedere a tutte le versioni dell'API di cui è stato eseguito il deployment in quella versione dell'applicazione App Engine utilizzando l'URL.

La versione pubblicata rimane la stessa finché non la modifichi esplicitamente nella Google Cloud console.

Accesso alle versioni dell'API di cui è stato eseguito il deployment in una versione dell'applicazione non di pubblicazione

Se devi accedere a versioni API non sottoposte a deployment nella versione di App Engine attualmente in servizio, utilizza un URL specifico della versione, simile al seguente:

https://VERSION-dot-YOUR_PROJECT_ID.appspot.com

Sostituisci VERSION con la tua versione di App Engine e YOUR_PROJECT_ID con l'ID progetto Google Cloud . Ad esempio, supponiamo che la versione di pubblicazione di App Engine sia 1, ma vuoi accedere a una versione dell'API di cui è stato eseguito il deployment nella versione 2. Devi utilizzare questo URL: https://2-dot-YOUR_PROJECT_ID.appspot.com.

Per ulteriori dettagli, consulta la documentazione di App Engine.

Accesso alle versioni dell'API di cui è stato eseguito il deployment in servizi non di pubblicazione (precedentemente moduli)

Se devi accedere a versioni API non implementate nel servizio App Engine predefinito, puoi utilizzare un URL specifico del servizio utilizzando la sintassi con il punto come segue:

https://SERVICE-NAME-dot-YOUR_PROJECT_ID.appspot.com/_ah/api/...

Per ulteriori dettagli, consulta la documentazione di App Engine.