Criar uma implantação para uma API REST no API Gateway - Amazon API Gateway
Criar uma implantaçãoPróximas etapas para sua implantação de API

Criar uma implantação para uma API REST no API Gateway

No API Gateway, uma implantação de API REST é representada por um recurso Deployment. Ele é semelhante a um executável de uma API que é representada por um recurso RestApi.

Para o cliente chamar a API, você deve criar uma implantação e associar um estágio a ela. Um estágio é representado por um recurso Stage. Ele representa um snapshot da API, incluindo métodos, integrações, modelos, modelos de mapeamento e autorizadores do Lambda (anteriormente conhecidos como autorizadores personalizados). Quando você atualiza a API, pode reimplantá-la associando um novo estágio à implantação existente. Discutimos a criação de um estágio em Configurar um estágio para uma API REST no API Gateway.

Criar uma implantação

Os procedimentos a seguir mostram como criar uma implantação para uma API REST.

AWS Management Console

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

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.

  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.

AWS CLI

Ao criar uma implantação, você instancia o recurso Deployment. Você pode usar o console do API Gateway, a AWS CLI, um SDK da AWS ou a API REST do API Gateway para criar uma implantação.

Para usar a CLI para criar uma implantação, use o comando create-deployment:

 aws apigateway create-deployment --rest-api-id <rest-api-id> --region <region>

A API não poderá ser chamada até que esta implantação seja associada a um estágio. Com um estágio já existente, você pode fazer isso atualizando a propriedade deploymentId do estágio com o ID de implantação recém-criado (<deployment-id>).

 aws apigateway update-stage --region <region> \
    --rest-api-id <rest-api-id> \ 
    --stage-name <stage-name> \ 
    --patch-operations op='replace',path='/deploymentId',value='<deployment-id>'

Ao implantar uma API pela primeira vez, você pode combinar a criação do estágio e da implantação ao mesmo tempo:

 aws apigateway create-deployment --region <region> \
    --rest-api-id <rest-api-id> \
    --stage-name <stage-name>

Isso é feito, nos bastidores, no console do API Gateway quando você implanta uma API pela primeira vez ou quando reimplanta a API em um novo estágio.

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

Próximas etapas para sua implantação de API

Veja a seguir as próximas etapas para a implantação da sua API.

Modificar as configurações de armazenamento

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 ter mais informações, consulte Modifique as configurações de armazenamento..

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 o novo perfil 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.

Escolher diferentes combinações de estágios de implantação

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.

Passe dados específicos da implantação para sua API.

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 Usar variáveis de estágio para uma API REST no API Gateway.