Gerenciar implantações

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

Visualização — Apigee API hub

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Uma API pode ter várias implantações. Por exemplo: regiões ou ambientes de preparo diferentes. Uma implantação é um local (um endereço) em que os usuários podem acessar uma API. Uma dessas implantações pode ser indicada como a implantação recomendada.

A guia Implantações exibe todas as implantações da API configuradas por um usuário com permissões de edição. As implantações são listadas em ordem alfabética por ambiente.

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	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 implantação

Para adicionar uma implantação:

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 Implantações.
4. Clique em Adicionar implantação.
5. Digite ou selecione:
   • ID: um identificador de um recurso de API. O ID só pode conter letras minúsculas, números e hífens. O ID precisa ser exclusivo no projeto. Os IDs precisam ter entre 4 e 63 caracteres. Os IDs não podem ser alterados depois que uma taxonomia for criada.
   • Ambiente: o local em que uma instância de uma API está disponível. Por exemplo: produção, preparo, teste etc.
   • Gateway:o tipo de gateway. O proxy usado para exibir e proteger a API. Definida como uma taxonomia do sistema.

   • Versão da API: a versão fornecida por esta implantação. Se uma versão não tiver revisões, ela será marcada como tal na lista e não poderá ser selecionada.

     
   • Nome e URL do Canal externo: rótulo e URL de um link para um canal externo da API, como um Portal do Desenvolvedor
   • Acessar informações
     • Orientação sobre o uso: orientação que especifica o público da implantação. Por exemplo, consumo público, testes internos etc.
     • Endpoint do servidor:o endpoint do servidor da API.
     • Orientação de acesso: conteúdo de marcação em formato livre que descreve como os consumidores da API podem ter acesso à implantação
6. Clique em Salvar (ou Cancelar).

Editar implantação

Para editar uma implantaçã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 Implantações.
4. Clique em Mais > Editar ao lado da implantação desejada.
5. Faça as modificações necessárias.

6. Revisão de atualização: essa caixa de seleção é exibida quando a versão atualmente selecionada tem uma revisão de especificação mais recente do que a já atribuída à implantação. Selecione esta caixa para atualizar a revisão da especificação implantada.

   
7. Clique em Salvar (ou Cancelar).

Excluir implantação

Para excluir uma implantaçã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 Implantações.
4. Clique em Mais > Excluir ao lado da implantação que você quer.
5. Clique em Excluir (ou Cancelar) no prompt.

Especificar a implantação recomendada

Para definir ou limpar uma implantação recomendada:

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 Implantações.
4. Na linha de implantação que você quer, clique em Mais > Definir como recomendado. Não é possível remover uma implantação recomendada. Só é possível especificar uma implantação diferente como a implantação recomendada.

Conseguir acesso

Observação: as informações de acesso são especificadas como parte da implantação. Para mais informações, consulte Adicionar implantação.

Para ver informações sobre como ter acesso a uma API, siga estas etapas:

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. No painel Geral ou na guia Implantações, clique em Receber acesso para abrir o painel da API Acesso. Se não houver um botão Receber acesso, nenhuma informação foi fornecida. Consulte Adicionar implantação para instruções sobre como adicionar informações de acesso.

4. Selecione uma implantação na lista. Se uma implantação não tiver informações de acesso, ela será marcada como tal na lista e não poderá ser selecionada.

   

Acessar o canal externo

Observação: um canal externo é definido quando você cria uma implantação. Para mais informações, consulte Adicionar implantação.

Para navegar até um canal externo, faça o seguinte:

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 Implantações.

4. Clique em um link de Canal externo para acessar um canal externo, como um portal, caso ele tenha sido definido.