Publicar várias versões da sua APIPublish multiple versions of your API

Quando não for prático ter todos os autores de chamadas direcionados para a sua API, utilize exatamente a mesma versão.There are times when it is impractical to have all callers to your API use exactly the same version. Quando os autores de chamadas quiserem atualizar para uma versão posterior, querem fazê-lo com uma abordagem de fácil compreensão.When callers want to upgrade to a later version, they want to be able to do this using an easy to understand approach. É possível fazê-lo com versões na Gestão de API do Azure.It is possible to do this using versions in Azure API Management. Para obter mais informações, veja Versões e revisões.For more information, see Versions & revisions.

Neste tutorial, ficará a saber como:In this tutorial, you learn how to:

  • Adicionar uma nova versão a uma API existenteAdd a new version to an existing API
  • Escolher um esquema de versãoChoose a version scheme
  • Adicionar a versão a um produtoAdd the version to a product
  • Navegar até ao portal do programador para ver a versãoBrowse the developer portal to see the version

A versão é apresentada no portal do programador

Pré-requisitosPrerequisites

Adicionar uma nova versãoAdd a new version

Menu de contexto da API - adicionar versão

  1. Selecione Demo Conference API na lista de APIs.Select Demo Conference API from the API list.
  2. Selecione o menu de contexto ( ... ) junto à mesma.Select the context menu (...) next to it.
  3. Selecione + Adicionar Versão.Select + Add Version.

Dica

As versões também podem ser ativadas quando criar uma nova API. Selecione Controlar a versão desta API? no ecrã Adicionar API.Versions can also be enabled when you first create a new API - select Version this API? on the Add API screen.

Escolher um esquema de versõesChoose a versioning scheme

A Gestão de API do Azure permite-lhe escolher a forma como permite aos autores de chamadas especificar a versão da API que querem.Azure API Management allows you to choose the way in which you allow callers to specify which version of your API they want. Especifica a versão da API a utilizar ao selecionar um esquema de versões.You specify which API version to use by selecting a versioning scheme. Este esquema pode ser um caminho, um cabeçalho ou uma cadeira de consulta.This scheme can be either path, header or query string. No exemplo seguinte, é utilizado o caminho para selecionar o esquema de versões.In the following example, path is used to select the versioning scheme.

Adicionar ecrã de versão

  1. Mantenha caminho selecionado como esquema de versões.Leave path selected as your versioning scheme.

  2. Escreva demo-conference-api-v1 no campo Nome.Type demo-conference-api-v1 in the Name field.

    Nota

    A versão é, na verdade, uma nova API com base na revisão de uma API.Version is in fact a new API based off an API's revision. O Nome é o nome da nova API e tem de ser exclusivo em toda a instância de Gestão de API.Name is the new API's name and it must be unique across API Management instance.

  3. Escreva v1 no campo Identificador da Versão.Type v1 in the Version identifier field.

    Dica

    Se selecionar cabeçalho ou cadeia de consulta como esquema de versões, tem de fornecer um valor adicional, o nome do cabeçalho ou o parâmetro da cadeia de consulta.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. Selecione Criar para configurar a nova versão.Select Create to set up your new version.

  5. Abaixo da API da Conferência de Demonstração, na Lista de APIs, pode ver agora duas APIs distintas: Original e v1.Underneath Demo Conference API in the API List, you now see two distinct APIs - Original, and v1.

    Versões listadas numa API no portal do Azure

    Nota

    Se adicionar uma versão a uma API sem versões, será criada automaticamente uma Original, que responde no URL predefinido.If you add a version to a non-versioned API, an Original will be automatically created - responding on the default URL. Isto garante que todos os autores de chamadas existentes não são divididos pelo processo de adição de uma versão.This ensures that any existing callers are not broken by the process of adding a version. Se criar uma nova API com versões ativadas no início, não é criada uma Original.If you create a new API with versions enabled at the start, an Original is not created.

  6. Agora, pode editar e configurar v1 como uma API separada da Original.You can now edit and configure v1 as an API that is separate to Original. As alterações a uma versão não afetam a outra.Changes to one version do not affect another.

Adicionar a versão a um produtoAdd the version to a product

Para os autores de chamadas verem a nova versão, esta tem de ser adicionada a um produto.In order for callers to see the new version, it must be added to a product.

Produtos da Gestão de API

  1. Selecione Produtos na página do modelo de implementação clássica.Select Products from the classic deployment model page.
  2. Selecione Ilimitados.Select Unlimited.
  3. Selecione APIs.Select APIs.
  4. Selecione Adicionar.Select Add.
  5. Selecione API da Conferência de Demonstração, Versão v1.Select Demo Conference API, Version v1.
  6. Clique em Selecionar.Click Select.

Navegar até ao portal do programador para ver a versãoBrowse the developer portal to see the version

  1. Selecione Portal do Programador no menu superior.Select Developer Portal from the top menu.
  2. Selecione APIs e clique na API de conferência de demonstração.Select APIs and click on the Demo Conference API.
  3. Você deverá ver uma lista suspensa com várias versões ao lado do nome da API.You should see a dropdown with multiple versions next to the API name.
  4. Selecione v1.Select v1.
  5. Repare no URL do pedido da primeira operação na lista.Notice the Request URL of the first operation in the list. Indica que o caminho do URL da API inclui v1.It shows that the API URL path includes v1.

Passos seguintesNext steps

Neste tutorial, ficará a saber como:In this tutorial, you learn how to:

  • Adicionar uma nova versão a uma API existenteAdd a new version to an existing API
  • Escolher um esquema de versãoChoose a version scheme
  • Adicionar a versão a um produtoAdd the version to a product
  • Navegar até ao portal do programador para ver a versãoBrowse the developer portal to see the version

Avance para o tutorial seguinte:Advance to the next tutorial: