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.
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.
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 |
|
Adicionar versão
Para adicionar uma versão, siga estas etapas:
No console do Google Cloud, acesse a página Hub de APIs.
A página da lista APIs é exibida por padrão.
- Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
- Selecione a guia Versões.
- Clique em Adicionar versão.
- 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.
- Clique em Salvar ou Cancelar.
Editar versão
Para editar uma versão:
No console do Cloud, acesse a página Hub de APIs.
A página da lista APIs é exibida por padrão.
- Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
- Selecione a guia Versões.
- Clique em Mais > Editar ao lado da versão desejada.
- Faça as modificações necessárias.
- Clique em Salvar ou Cancelar.
Excluir versão
Para excluir uma versão:
No console do Cloud, acesse a página Hub de APIs.
A página da lista APIs é exibida por padrão.
- Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
- Selecione a guia Versões.
- Clique em Mais > Excluir ao lado da versão desejada.
- Clique em Excluir (ou Cancelar) no prompt.