Implantar uma API REST pelo console do API Gateway

Você deve ter criado uma API REST antes de implantá-la pela primeira vez. Para obter mais informações, consulte Criação de uma API REST no Amazon API Gateway.

Implantar uma API REST em um estágio

O console do API Gateway permite que você implante uma API criando uma implantação e associando-a a um estágio novo ou existente.

nota

Para associar um estágio no API Gateway a uma implantação diferente, consulte Associar um estágio à implantação de uma API REST diferente.

1. Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway.

2. No painel de navegação APIs, escolha a API que você deseja implantar.

3. No painel Resources (Recursos), escolha Deploy API (Implantar API).

4. Em Estágio, selecione uma das seguintes opções:

   1. Para criar um estágio, selecione Novo estágio e insira um nome em Nome do estágio. Opcionalmente, você pode fornecer uma descrição para a implantação em Descrição da implantação.

   2. Para escolher um estágio existente, selecione o nome dele no menu suspenso. É aconselhável fornecer uma descrição para a nova implantação em Descrição da implantação.

   3. Para criar uma implantação que não esteja associada a um estágio, selecione Sem estágio. Posteriormente, você poderá associar essa implantação a um estágio.

5. Escolha Implantar.

Reimplantar uma API REST em um estágio

Para reimplantar uma API, execute as mesmas etapas descritas em Implantar uma API REST em um estágio. É possível reutilizar o mesmo estágio quantas vezes quiser.

Atualizar a configuração de estágio de uma implantação da API REST

Depois que uma API é implantada, é possível modificar as configurações de estágio para habilitar ou desabilitar o cache, o registro em log ou a limitação de solicitações dessa API. Você também pode escolher um certificado de cliente para o backend autenticar o API Gateway e definir variáveis de estágio para transmitir o contexto de implantação para a integração da API em tempo de execução. Para obter mais informações, consulte Atualizar configurações de estágio.

Importante

Depois de modificar as configurações do estágio, você deve reimplantar a API para que as alterações entrem em vigor.

nota

Se as configurações atualizadas, como a habilitação de registro em log, exigirem uma nova função do IAM, você poderá adicionar a função do IAM necessária sem reimplantar a API. No entanto, pode demorar alguns minutos para a nova função do IAM entrar em vigor. Antes que isso aconteça, os rastreamentos das suas chamadas de API não são registrados em log, mesmo que você tenha habilitado a opção de registro em log.

Definir variáveis de estágio para a implantação de uma API REST

Para uma implantação, é possível definir ou modificar variáveis de estágio para transmitir dados específicos da implantação à integração da API em tempo de execução. Você pode fazer isso na guia Variáveis de estágio no Editor de estágio. Para obter mais informações, consulte as instruções em Configurar variáveis de estágio para a implantação de uma API REST.

Associar um estágio à implantação de uma API REST diferente

Como uma implantação representa um snapshot de API e um estágio define um caminho em um snapshot, você pode escolher diferentes combinações de estágio de implantação para controlar como os usuários invocam diferentes versões da API. Isso é útil, por exemplo, quando você deseja reverter o estado da API para uma implantação anterior ou mesclar uma "ramificação particular" da API na ramificação pública.

O procedimento a seguir mostra como fazer isso usando o Stage Editor (Editor de estágio) no console do API Gateway. Supõe-se que você tenha implantado uma API mais de uma vez.

1. Se você ainda não estiver no painel Estágios, no painel de navegação principal, escolha Estágios.

2. Selecione o estágio que você deseja atualizar.

3. Na guia Histórico de implantação, escolha a implantação que o estágio deve usar.

4. Escolha Alterar implantação ativa.

5. Confirme que você deseja alterar a implantação ativa e escolha Alterar implantação ativa na caixa de diálogo Tornar implantação ativa.