Pubblicare più versioni dell'APIPublish multiple versions of your API

Può risultare poco pratico che tutti i chiamanti dell'API usino esattamente la stessa versione.There are times when it is impractical to have all callers to your API use exactly the same version. Quando i chiamanti sono pronti per passare a una versione successiva dell'API, preferiscono farlo adottando un approccio facile da comprendere.When callers want to upgrade to a later version, they want to be able to do this using an easy to understand approach. A questo scopo, è possibile usare le versioni in Gestione API di Azure.It is possible to do this using versions in Azure API Management. Per altre informazioni, vedere Versions & revisions (Versioni e revisioni).For more information, see Versions & revisions.

In questa esercitazione si apprenderà come:In this tutorial, you learn how to:

  • Aggiungere una nuova versione a un'API esistenteAdd a new version to an existing API
  • Scegliere uno schema di versioneChoose a version scheme
  • Aggiungere la versione a un prodottoAdd the version to a product
  • Passare al portale per sviluppatori per visualizzare la versioneBrowse the developer portal to see the version

Versione visualizzata sul portale per sviluppatori

PrerequisitiPrerequisites

Aggiungere una nuova versioneAdd a new version

Menu di scelta rapida delle API - Aggiungere versione

  1. Selezionare Demo Conference API (API Demo Conference) nell'elenco di API.Select Demo Conference API from the API list.
  2. Selezionare il menu di scelta rapida ( ... ).Select the context menu (...) next to it.
  3. Selezionare + Aggiungi versione.Select + Add Version.

Suggerimento

È possibile abilitare le versioni anche quando si crea una nuova API. A tal fine, nella schermata Aggiungi API selezionare Assegnare un numero di versione a questa API? .Versions can also be enabled when you first create a new API - select Version this API? on the Add API screen.

Scegliere uno schema di controllo delle versioniChoose a versioning scheme

In Gestione API di Azure è possibile scegliere come consentire ai chiamanti di specificare quale versione dell'API usare.Azure API Management allows you to choose the way in which you allow callers to specify which version of your API they want. Specificare la versione API da usare selezionando uno schema di controllo delle versioni.You specify which API version to use by selecting a versioning scheme. Può trattarsi di uno schema stringa di query, percorso o intestazione.This scheme can be either path, header or query string. Nell'esempio seguente viene usato uno schema percorso come schema di controllo delle versioni.In the following example, path is used to select the versioning scheme.

Aggiungere una schermata di versione

  1. Lasciare percorso selezionato come lo schema di controllo delle versioni.Leave path selected as your versioning scheme.

  2. Digitare demo-conference-api-v1 nel campo Nome.Type demo-conference-api-v1 in the Name field.

    Nota

    La versione è in realtà una nuova API basata sulla revisione di un'API.Version is in fact a new API based off an API's revision. Nome è il nome della nuova API e deve essere univoco nell'istanza di Gestione API.Name is the new API's name and it must be unique across API Management instance.

  3. Digitare v1 nel campo Identificatore della versione.Type v1 in the Version identifier field.

    Suggerimento

    Se si seleziona intestazione o stringa di query come schema di controllo delle versioni, è necessario fornire un altro valore, ovvero il nome dell'intestazione o il parametro della stringa di query.If you select header or query string as a versioning scheme, you need to provide an additional value - the name of the header or query string parameter.

  4. Selezionare Crea per impostare la nuova versione.Select Create to set up your new version.

  5. Nell'elenco delle API sotto a Demo Conference API (API Demo Conference) verranno mostrate due API distinte: Original e v1.Underneath Demo Conference API in the API List, you now see two distinct APIs - Original, and v1.

    Versioni elencate per un'API nel portale di Azure

    Nota

    Se si aggiunge una versione a un'API senza versione, viene automaticamente creata una versione originale, che risponde dall'URL predefinito.If you add a version to a non-versioned API, an Original will be automatically created - responding on the default URL. Ciò garantisce che i chiamanti esistenti non subiscano interruzioni a causa della procedura di aggiunta della versione.This ensures that any existing callers are not broken by the process of adding a version. Se si crea una nuova API con le versioni abilitate sin dall'inizio, non viene creato alcun originale.If you create a new API with versions enabled at the start, an Original is not created.

  6. È ora possibile modificare e configurare v1 come API distinta dall'originale.You can now edit and configure v1 as an API that is separate to Original. Le modifiche apportate a una versione non influiscono sulle altre.Changes to one version do not affect another.

Aggiungere la versione a un prodottoAdd the version to a product

Perché i chiamanti possano visualizzare la nuova versione, questa deve essere aggiunta a un prodotto.In order for callers to see the new version, it must be added to a product.

Prodotti Gestione API

  1. Selezionare Prodotti nella pagina del modello di distribuzione classica.Select Products from the classic deployment model page.
  2. Selezionare Illimitato.Select Unlimited.
  3. Selezionare API.Select APIs.
  4. Selezionare Aggiungi.Select Add.
  5. Selezionare Demo Conference API, Version v1 (API Demo Conference, versione v1).Select Demo Conference API, Version v1.
  6. Fare clic su Seleziona.Click Select.

Passare al portale per sviluppatori per visualizzare la versioneBrowse the developer portal to see the version

  1. Selezionare Portale per sviluppatori dal menu principale.Select Developer Portal from the top menu.

  2. Selezionare API e notare che Demo Conference API (API Demo Conference) mostra le versioni Original e v1.Select APIs, notice that Demo Conference API shows Original and v1 versions.

  3. Selezionare v1.Select v1.

  4. Si noti l'URL della richiesta della prima operazione nell'elenco.Notice the Request URL of the first operation in the list. Mostra che il percorso dell'URL dell'API include v1.It shows that the API URL path includes v1.

    Menu di scelta rapida delle API - Aggiungere versione

Passaggi successiviNext steps

In questa esercitazione si apprenderà come:In this tutorial, you learn how to:

  • Aggiungere una nuova versione a un'API esistenteAdd a new version to an existing API
  • Scegliere uno schema di versioneChoose a version scheme
  • Aggiungere la versione a un prodottoAdd the version to a product
  • Passare al portale per sviluppatori per visualizzare la versioneBrowse the developer portal to see the version

Passare all'esercitazione successiva:Advance to the next tutorial: