Gerenciar versões

Esta página se aplica à Apigee e à Apigee híbrida.

Uma versão é uma interface bem definida de uma API que fornece estabilidade para o consumo de aplicativos. É possível ter várias versões de uma API.

Uma API pode ter várias implantações. Cada implantação pode ter uma versão diferente.

As versões são associadas a uma API por um usuário com permissões para edição ao registrar uma API, e associadas a uma implantação ao adicionar ou editar uma implantação.

Guia Versões, clique para ampliar a imagem
Ver esquema do Registro da API

Veja a seguir a relação entre as APIs do hub da API, as versões, as implantações e as especificações.

alt_text
Referência Item Descrição
Registro O registro é um conjunto de APIs que serve como um catálogo de APIs.
Versão Uma API pode ter várias versões. A versão precisa corresponder a uma interface estável que os clientes podem usar para chamar uma API. Uma dessas versões pode ser designada como a recomendada. Na terminologia semver, é uma prática recomendada que as versões sejam versões principais.
Deployment Uma API pode ter várias implantações, por exemplo, diferentes ambientes ou regiões de preparo. Uma implantação é um local (um endereço) em que os usuários podem acessar uma API. Uma dessas implantações pode ser a recomendada.
Especificação Recomendamos, mas não é obrigatório, que uma versão da API seja descrita por especificações formais, geralmente usando diferentes formatos de especificação de API. Um desses formatos de especificação pode ser principal, o que indica que outras especificações dessa versão são derivadas dela.
Revisões
  • As implantações têm um histórico de revisões. As revisões de implantação representam instâncias específicas de uma implantação a tempo e podem se referir a uma ou mais revisões de especificações, se a implementação da API exibida pela implantação for alterada.
  • As especificações têm um histórico de revisões. As revisões de especificação representam instâncias subsequentes de uma especificação e normalmente representam alterações não interruptivas no conteúdo das especificações. Na terminologia semver, as revisões podem corresponder a versões secundárias ou pontuais.

Adicionar versão

Para adicionar uma versão, siga estas etapas:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. Selecione a guia Versões.
  4. Clique em Adicionar versão.
  5. Especifique os detalhes:
    • Insira o ID. Use letras minúsculas, números e hifens (-). Por exemplo, v1, v1, 1, 1-0-0 etc.
    • Insira a Versão. Use qualquer caractere.
    • Selecione uma etapa do ciclo de vida da API.
    • Expectativa de fim da vida útil:
      • Selecione uma Expectativa na lista.
      • Se Expectativa for Data mínima, especifique uma Data.
      • Se Expectativa for Data de confirmação, especifique uma Data.
  6. Clique em Salvar ou Cancelar.

Editar versão

Para editar uma versão:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. Selecione a guia Versões.
  4. Clique em Mais > Editar ao lado da versão desejada.
  5. Faça as modificações necessárias.
  6. Clique em Salvar ou Cancelar.

Excluir versão

Para excluir uma versão:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. Selecione a guia Versões.
  4. Clique em Mais > Excluir ao lado da versão desejada.
  5. Clique em Excluir (ou Cancelar) no prompt.