Criação de um ambiente e uma variável de ambiente

Cenário

Uma API pode ser chamada em diferentes ambientes, como ambientes de produção, teste e desenvolvimento. RELEASE é o ambiente padrão fornecido pelo APIG. Você pode definir variáveis de ambiente para permitir que uma API seja chamada em ambientes diferentes.

As variáveis de ambiente são gerenciáveis e específicas para ambientes. Você pode criar variáveis em ambientes diferentes para chamar diferentes serviços de back-end usando a mesma API.

Para variáveis definidas durante a criação da API, você deve criar variáveis e valores correspondentes. Por exemplo, a variável Path é definida para uma API e duas variáveis com o mesmo nome são criadas e atribuídas valores /Stage/test e /Stage/AA nos ambientes 1 e 2, respectivamente. Se a API for publicada e chamada no ambiente 1, o caminho /Stage/test será usado. Se a API for publicada e chamada no ambiente 2, o caminho /Stage/AA será usado.

Figura 1 Uso de variáveis de ambiente

Você pode criar no máximo 50 variáveis para um grupo de API em cada ambiente.

Pré-requisitos

Você criou um grupo de APIs.

Criação de um ambiente

1. Acesse o console de gerenciamento.
2. Clique em no canto superior esquerdo e selecione uma região.
3. Clique em no canto superior esquerdo e escolha API Gateway.
4. Escolha um tipo de gateway no painel de navegação.
   • Shared Gateway: você pode criar e gerenciar APIs imediatamente. Você será cobrado com base no número de chamadas de API.
   • Dedicated Gateways: você pode criar e gerenciar APIs depois de comprar um gateway. Você será cobrado com base na duração de uso do gateway.

5. No painel de navegação, escolha API Publishing > Environments.
6. Clique em Create Environment e defina os parâmetros listados em Tabela 1.
   Figura 2 Criação de um ambiente
   

   Tabela 1 Informações de ambiente

   Parâmetro	Descrição
   Name	Nome do ambiente.
   Description	Descrição do ambiente.

7. Clique em OK.

   Depois que o ambiente é criado, ele é exibido na lista de ambientes.

Acessar um ambiente

Você pode chamar uma API no ambiente RELEASE usando uma API RESTful. Para acessar a API em outros ambientes, adicione o cabeçalho X-Stage à solicitação para especificar um nome de ambiente. Por exemplo, adicione X-Stage:DEVELOP ao cabeçalho da solicitação para acessar uma API no ambiente DEVELOP.

O APIG não suporta depuração de API usando variáveis de ambiente.

Criação de uma variável de ambiente

1. Acesse o console de gerenciamento.
2. Clique em no canto superior esquerdo e selecione uma região.
3. Clique em no canto superior esquerdo e escolha API Gateway.
4. Escolha um tipo de gateway no painel de navegação.
   • Shared Gateway: você pode criar e gerenciar APIs imediatamente. Você será cobrado com base no número de chamadas de API.
   • Dedicated Gateways: você pode criar e gerenciar APIs depois de comprar um gateway. Você será cobrado com base na duração de uso do gateway.

5. No painel de navegação, escolha API Publishing > API Groups.
6. Crie uma variável. Você pode usar um dos seguintes métodos:
   • Clique no nome do grupo de API de destino e clique na guia Variables na página de detalhes do grupo de API exibida.
   • Na coluna Operation do grupo de APIs de destino, escolha More > Manage Variable.

7. Selecione um ambiente na lista suspensa Environment e clique em Create Variable.
8. Defina os parâmetros listados em Tabela 2.
   Figura 3 Criação de uma variável de ambiente
   

   Tabela 2 Parâmetros para criar uma variável de ambiente

   Parâmetro	Descrição
   Name	Nome da variável que você deseja criar. Verifique se o nome é igual ao nome da variável definida para a API.
   Value	O caminho a ser usado no ambiente selecionado.

9. Clique em OK.
   

   Se uma variável não for necessária, clique em Delete na linha que contém a variável para excluí-la.

   Os nomes e valores das variáveis de ambiente serão exibidos em texto sem formatação nas solicitações da API. Não inclua informações confidenciais nos nomes e valores das variáveis.

Operações de acompanhamento

Depois de criar um ambiente e uma variável, publique APIs no ambiente para que possam ser chamadas pelos chamadores da API.

Criação de um ambiente e variável de ambiente chamando uma API

Você também pode criar um ambiente e uma variável de ambiente chamando uma API fornecida pelo APIG. Para detalhes, consulte as seguintes referências:

Criação de um ambiente

Criação de uma variável de ambiente

Perguntas frequentes sobre variáveis de ambiente

Poder invocar diferentes serviços de back-end publicando uma API em ambientes diferentes?