Para manter o tráfego de desenvolvimento, homologação e produção isolados, o API Gateway oferece três ambientes integrados — TEST, PRE e RELEASE — e permite criar ambientes personalizados que mapeiam as mesmas configurações de API para diferentes URLs de backend.
Como funcionam os ambientes
O API Gateway encaminha cada solicitação de API para uma URL de backend com base no ambiente de destino. A mesma configuração de API pode apontar para uma URL de backend diferente em cada ambiente, o que permite validar alterações com segurança antes que cheguem à produção.
Para usar ambientes, siga estas etapas:
(Opcional) Crie um ambiente personalizado: Use o console do API Gateway para criar ambientes além dos três integrados.
Configure o service de backend: Defina uma URL de backend distinta para cada ambiente e garanta o encaminhamento das solicitações de API ao backend correto.
Configure o cliente: Os clientes devem direcionar as solicitações a um ambiente específico. Vincule um nome de domínio separado a cada ambiente ou exija o envio do cabeçalho X-Ca-Stage nas solicitações.
Criar um ambiente
O API Gateway fornece três ambientes integrados: TEST, PRE e RELEASE. Caso esses ambientes não atendam aos seus requisitos, crie um ambiente personalizado.
Faça login no console do API Gateway para visualizar os ambientes disponíveis.
-
Clique em Create Environment. Na caixa de diálogo Create Environment, preencha os campos a seguir. O nome e o alias do ambiente devem ser globalmente exclusivos.
Environment Name: De 2 a 10 caracteres; apenas letras maiúsculas e dígitos; deve começar com uma letra maiúscula.
Alias: Nome de exibição do ambiente. De 2 a 50 caracteres; permite letras, dígitos e sublinhados (_).
Description: Breve descrição do ambiente.
Clique em Confirm para criar o ambiente.
Usar ambientes
Configurar um service de backend com URLs de ambiente
Gerencie suas aplicações de backend de API por meio de services de backend e configure uma URL diferente para cada ambiente. Para obter instruções de configuração, consulte as etapas 1 e 2 em Use a backend service to create and manage APIs.
Publicar APIs em um ambiente
Após criar e configurar um service de backend, crie uma API para que os clientes possam chamá-la. Para instruções sobre criação e depuração de uma API, consulte as etapas 3, 4 e 5 em Use a backend service to create and manage APIs. É possível publicar a API em qualquer ambiente, incluindo TEST, PRE, RELEASE e quaisquer ambientes personalizados criados por você.
Usar o cabeçalho X-Ca-Stage para direcionar um ambiente
Durante a depuração, teste sua API usando o nome de domínio de segundo nível fornecido pelo sistema ou o cabeçalho de solicitação X-Ca-Stage. Se você vinculou um nome de domínio independente ao grupo de APIs e definiu o parâmetro Environment como Default (X-Ca-Stage), os clientes podem usar o cabeçalho X-Ca-Stage para acessar um ambiente específico.
Para chamar a API no ambiente RELEASE, omita o cabeçalho X-Ca-Stage.
Para chamar a API no ambiente PRE, adicione o cabeçalho X-Ca-Stage: PRE a cada solicitação.
Para chamar a API no ambiente TEST, adicione o cabeçalho X-Ca-Stage: TEST a cada solicitação.
Para chamar a API em um ambiente personalizado, adicione o cabeçalho X-Ca-Stage: environment name, substituindo environment name pelo nome real do ambiente.
Vincular um nome de domínio a um ambiente
Vincule um nome de domínio dedicado a cada ambiente para que os clientes possam chamar APIs sem precisar especificar o cabeçalho X-Ca-Stage. Selecione o ambiente de destino ao vincular um nome de domínio independente a um grupo de APIs. Para mais detalhes, consulte Bind a custom domain name to allow API calls.
A vinculação de nome de domínio tem precedência sobre o cabeçalho X-Ca-Stage. O API Gateway encaminha as solicitações com base na configuração de vínculo, independentemente de qualquer valor de cabeçalho X-Ca-Stage enviado pelo cliente.
Excluir um ambiente
Faça login no console do API Gateway para visualizar os ambientes disponíveis.
Localize o ambiente que deseja excluir e clique em Delete na coluna Actions.
Não é possível excluir ambientes integrados.
Não é possível excluir ambientes com services de backend associados.
Não é possível excluir ambientes com APIs publicadas.