Configuração e Utilização de Environments

          Várias etapas constituem o processo de concepção de uma API, sendo necessário para cada etapa ambientes diferentes e isolados. Configurar tais ambientes de maneira adequada, permite que a API passe por diversos testes até que seja finalizada e exposta ao uso, possibilitando que a API entre em produção com maior qualidade e segurança.

          Ao utilizar ambientes isolados ou Environments, conforme é apresentado pela plataforma, apenas as pessoas e equipes interessadas às devidas partes, poderão acessar os ambientes designados, permitindo independência entre os ambientes criados e conferindo diferentes formas e períodos de implantação.

Environments

          Para acessar os ambientes configurados ou criar um novo ambiente, basta acessar, na lateral esquerda do manager, o item Environments.

          Na página acessada, é possível encontrar os Environments disponíveis e as informações a respeito de cada um deles, como o Nome e Inbound URL, além de informações sobre o Gateway configurado.

 

          Digitando, por exemplo, “name: nome do Environment” ou “InboundURL:Url configurada” no campo de busca, uma lista de sugestões irá aparecer com os ambientes já configurados, com termos disponíveis para criar um filtro de busca.



 

          Dependendo da permissão concedida ao login do usuário, é permitida ou não a edição e criação de novos Environments. A Role configurada a seguir, permite, por exemplo, ao usuário visualizar e editar os ambientes.
 

 

Criando um novo Environment

          Para criar um novo ambiente, clique no ícone Create Environment, no canto inferior direito da página:

 

          Na tela de criação, as seguintes informações devem ser inseridas: 

  • Name - Nome do novo Ambiente;
  • Inbound URL - URL que representa este Environment, recebendo as requisições realizadas às APIs que forem implantadas neste ambiente;
  • Description - Descrição do Ambiente.

 

Observação: A configuração de uma URL válida, no Inbound URL, é crucial para o correto funcionamento do Environment. Caso seja configurado uma URL que direcione a chamada para outro domínio, o recurso que se deseja consumir, de uma API, não será encontrado.

 

          É necessário também configurar as permissões para deploy e a visibilidade do novo ambiente no trace de chamadas. 

  • Organization - Acesso permitido a todos os usuários logados;
  • Teams - Acesso permitido apenas aos times incluídos no instante da configuração;
  • Only me - Acesso apenas do usuário que criou o ambiente.

 

          Uma vez que o usuário não tem permissão para realizar o Deploy, o Environment deverá aparecer como :

 

          Por fim, selecione o Gateway e clique em salvar.

 

Environment Variables

          Embora não seja de uso obrigatório, as variáveis de ambiente permitem maior praticidade no processo de design e de gerenciamento de APIs. 

     Imagine que um mesmo Target Destination deva ser configurado em diversas API’s e que após determinado tempo esse endereço venha a ser alterado. Uma vez que uma variável de ambiente é utilizada, basta que apenas uma alteração seja feita no ambiente utilizado para que todas as APIs tenham seus Destinations atualizados.

 

         Para criar uma nova variável de ambiente, clique em ADD MAP ou em IMPORT MAP, caso queira importar variáveis de outro ambiente já criado.

          Insira o nome do MAP a ser criado, a descrição do mesmo e clique em salvar.

 

         Tendo sido criado o MAP, insira o nome da variável e seu respectivo valor, que neste caso é uma URL que será utilizada como endpoint de uma API.

          Por fim, clique em salvar variável para confirmar as informações inseridas.

 

 

Utilizando o Environment e suas variáveis

          Uma vez criado, o Environment pode ser utilizado em uma API, tanto no cadastro de uma nova quanto na edição de uma API já existente.

          A figura a seguir ilustra a lista de ambientes disponíveis para serem incluídos durante o cadastro de uma nova API.

 

           Caso a API já exista, ao acessar o overview da API, através do botão ADD Environments é possível incluir um novo ambiente.

 

 

          Após adicionado, é possível realizar algumas ações, como efetuar o Deploy ou remover ambiente.

         Outras informações são presentes, como número da Revision e link do Environment.

 

 

          Para utilizar uma variável de ambiente, igual a criada anteriormente, como endpoint de uma API, basta inserir o nome da variável no target destination no fluxo desejado, conforme a figura a seguir.

Observação: Todas as variáveis de ambiente ao serem referenciadas nas APIs ou nos interceptors devem ser precedidas do símbolo $.

 

Deploy de um Environment

         É importante ressaltar a funcionalidade do Deployuma vez que este é responsável por alterar o status da conectividade entre a API e o gateway

          Através do Deploy é que será criado a rota entre o gateway configurado no Environment e a API que será consumida.

Deploy.png

          Conforme é mostrado na imagem acima, quando foi realizado o deploy de um ambiente (Production), a rota entre uma API e um Gateway (GW1) é criada.
          Caso o Deploy não tenha sido realizado, a rota não é estabelecida, por exemplo, mostrado por GW2 e o ambiente de Sandbox.

          Uma vez não realizado o deploy, é esperado um erro  404, com a mensagem: 

Could not route request: http://api.domain.com/api-basepath

 

 

 

 

 

Tem mais dúvidas? Envie uma solicitação

Comentários

Desenvolvido por Zendesk