Thanks for your feedback!
EDIT
Variáveis de ambiente
Environment variables são variáveis com valores únicos para um ambiente específico. Elas são usadas como configurações adicionais de cada ambiente, permitindo personalizar requisições para alternar facilmente entre contextos diferentes. Não é obrigatório criá-las, mas seu uso facilita o processo de design e gerenciamento de APIs.
O API Manager permite criar variáveis de ambiente para serem usadas em diversos pontos da nossa plataforma:
-
No Target ou Timeout da API Destination;
-
Ao habilitar um Connector; ou
-
Em diversos Interceptors, como mostra a tabela abaixo:
Interceptors que permitem o uso de variáveis de ambiente:
Time allowed |
XML Threat protection |
Service mashup |
Query param |
|
Imagine que várias APIs implantadas em um ambiente compartilham o mesmo target destination e, em algum momento, esse destino mude. Sem variáveis de ambiente, seria necessário alterar o target destination em cada API. No entanto, se ele estiver definido como uma variável de ambiente, basta modificar o valor dessa variável no ambiente específico, e todas as APIs serão atualizadas automaticamente. |
Cadastrando variáveis de ambiente
Para cadastrar variáveis de ambiente, você precisa adicionar um mapa de variáveis (Variables Map), ou importar um mapa existente de outro ambiente.
Para adicionar um mapa:
-
Clique no botão ADD MAP;
-
Na tela que abrir, defina o nome para o mapa.
Agora você pode criar variáveis de ambiente como pares chave-valor, ambos do tipo string.
O campo Type permite mudar o tipo da variável para uma das opções abaixo:
-
DEFAULT: tipo padrão para todas as variáveis. Não muda nada em seu comportamento.
-
SECURED: valor criptografado, decriptado apenas pelo fluxo de um connector, garantindo mais segurança ao armazenar credenciais, já que o valor não é resgatável de nenhuma outra forma.
Você pode ainda adicionar um certificado correspondente à comunicação entre o gateway e o backend. Quando a variável de ambiente for utilizada, ele será aplicado:
-
Clique no ícone
; -
Selecione o certificado cadastrado na página Certificates.
Para importar um mapa de outro ambiente:
-
Clique no botão IMPORT MAP;
-
Selecione o nome do ambiente que contém o mapa e o sistema carregará os mapas existentes;
-
Após selecionar o mapa, clique em IMPORT MAP.
As variáveis de ambiente do mapa serão carregadas. Você poderá:
-
visualizá-las clicando no ícone para estender abas ao lado do nome do mapa;
-
editá-las clicando no ícone
; -
excluí-las clicando no ícone
. -
adicionar novas variáveis a um mapa clicando no ícone
e, após, no botão de +.
Nessa mesma aba, você poderá editar nome e descrição do mapa, ou excluí-lo.
Gestão de variáveis de ambiente
Quando você cria variáveis em um ambiente, elas são associadas ao ambiente como um todo, e não a uma API específica. Por isso, é importante seguir boas práticas de gestão e organização. Recomendamos que utilize um padrão de nomenclatura claro e consistente para todas as variáveis. Isso facilita sua identificação e uso correto.
Exemplo de uso
Considere duas variáveis de ambiente criadas: destination, com um endereço válido, e rateLimit, com o valor 2.
A variável de ambiente $destination pode ser usada como o endpoint de uma API.
Quando uma requisição for realizada, o gateway irá direcionar a chamada para o endereço configurado.
Para isso, basta referenciar a variável de ambiente no Target Destination da API, conforme a imagem a seguir.
A variável de ambiente $rateLimit pode ser usada no interceptor de mesmo nome para definir o limite de chamadas, substituindo o valor configurado (neste caso, 2).
|
Share your suggestions with us!
Click here and then [+ Submit idea]