As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Configurar uma solicitação de integração de API usando o console do API Gateway
A configuração de um método de API define o método e descreve seus comportamentos. Para configurar um método, você deve especificar um recurso, incluindo a raiz ("/"), na qual o método está exposto, um método HTTP (GET
, POST
etc.) e como ele será integrado com o back-end de destino. A solicitação e a resposta do método especificam o contrato com o aplicativo iniciador da chamada, estipulando quais parâmetros a API pode receber e qual é a aparência da resposta.
O procedimento a seguir descreve como usar o console do API Gateway para especificar configurações de método.
-
No painel Recursos, escolha Criar método.
Em Tipo de método, selecione um método HTTP.
Em Tipo de integração, selecione uma das seguintes opções:
-
Selecione Função do Lambda se a API for integrada a uma função do Lambda. No nível da API, esse é um tipo de integração da
AWS
, se você criar uma integração sem proxy, ou um tipo de integraçãoAWS_PROXY
, se criar uma integração de proxy. -
Escolha HTTP, se a sua API for integrada a um endpoint HTTP. No nível da API, este é o tipo de integração
HTTP
. -
Selecione Serviço da AWS se a API for integrada diretamente a um serviço da AWS. No nível da API, este é o tipo de integração
AWS
. A opção Função do Lambda é um caso especial de integração daAWS
para invocar uma função do Lambda.Para configurar uma API do API Gateway, siga qualquer um destes procedimentos:
Crie uma nova função do Lambda.
Defina uma permissão de recurso na função do Lambda.
Execute qualquer outra ação do serviço do Lambda.
Você deve escolher o Serviço da AWS.
-
Escolha Mock (Simular) se quiser que o API Gateway atue como seu backend para retornar respostas estáticas. No nível da API, este é o tipo de integração
MOCK
. Normalmente, você pode usar a integraçãoMOCK
quando a sua API ainda não for final e você quiser gerar respostas de API para desbloquear equipes dependentes para testes. Para o métodoOPTION
, o API Gateway define a integraçãoMOCK
como padrão para retornar cabeçalhos com compartilhamento de recursos de origem cruzada para o recurso da API aplicada. Se você escolher essa opção, pule o restante das instruções neste tópico e consulte Configurar integrações simuladas no API Gateway.
-
-
Se você escolheu Função do Lambda, faça o seguinte:
-
Para usar uma integração do proxy do Lambda, ative Integração do proxy do Lambda. Para saber mais sobre integrações do proxy do Lambda, consulte Compreender a integração de proxy do Lambda do API Gateway.
-
Em Função do Lambda, insira o nome da sua função do Lambda. Se você estiver usando uma função do Lambda em uma região que não seja a da API, selecione a região no menu suspenso e insira o nome da função do Lambda. Se você estiver usando uma função do Lambda entre contas, insira o ARN da função.
Para obter uma lista de nomes e identificadores de regiões, consulte AWS Lambda na Referência geral da Amazon Web Services.
-
Para usar o valor de tempo limite padrão de 29 segundos, deixe a opção Tempo limite padrão ativada. Para definir um tempo limite personalizado, selecione Tempo limite padrão e insira um valor de tempo limite entre
50
e29000
milissegundos. -
Escolha Criar método.
-
-
Se você escolheu HTTP, faça o seguinte:
-
Para usar uma integração de proxy HTTP, ative a Integração do proxy HTTP. Para saber mais sobre integrações de proxy HTTP, consulte Configurar integrações de proxy HTTP no API Gateway.
-
Em HTTP method (Método HTTP), escolha o tipo de método HTTP mais parecido com o método no backend HTTP.
-
Em URL do endpoint, insira o URL do back-end HTTP que você deseja que esse método use.
-
Em Manuseio de conteúdo, selecione um comportamento de manuseio de conteúdo.
-
Para usar o valor de tempo limite padrão de 29 segundos, deixe a opção Tempo limite padrão ativada. Para definir um tempo limite personalizado, selecione Tempo limite padrão e insira um valor de tempo limite entre
50
e29000
milissegundos. -
Escolha Criar método.
-
-
Se você escolheu Mock (Simular), faça o seguinte:
-
Escolha Criar método.
-
-
Se você escolheu Serviço da AWS, faça o seguinte:
-
Para Região da AWS, escolha a região da AWS que esse método deve usar para chamar a ação.
-
Em Serviço da AWS, selecione o serviço da AWS que esse método deve chamar.
-
Em Subdomínio da AWS, digite o subdomínio usado pelo serviço da AWS. Normalmente, você deixaria este campo em branco. Alguns serviços daAWS podem oferecer suporte a subdomínios como parte dos hosts. Consulte a documentação do serviço para a disponibilidade e, se disponível, detalhes.
-
Para HTTP method (Método HTTP), escolha o tipo de método HTTP que corresponde à ação. Para o tipo de método HTTP, consulte a documentação de referência da API para o serviço da AWS que você escolheu em Serviço da AWS.
-
Em Tipo de ação, selecione Usar nome da ação para usar uma ação de API ou Usar a substituição de caminho para usar um caminho de recurso personalizado. Para conhecer as ações e os caminho de recurso personalizado disponíveis, consulte a documentação de referência de API do serviço da AWS que você escolheu em Serviço da AWS.
-
Insira o Nome da ação ou Substituição do caminho.
-
Em Função de execução, digite o ARN do perfil do IAM que o método usará para chamar a ação.
Para criar um perfil do IAM, é possível adaptar as instruções em Etapa 1: Criar o perfil de execução do proxy de serviço da AWS. Especifique uma política de acesso do seguinte formato, com o número desejado de instruções de recursos e ações:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "
action-statement
" ], "Resource": [ "resource-statement
" ] }, ... ] }Para a sintaxe da instrução de ação e recurso, consulte a documentação do serviço da AWS que você escolheu em Serviço da AWS.
Para a relação de confiança da função do IAM, especifique o seguinte, que permite que o API Gateway tome medidas em nome da sua conta da AWS:
{ "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": "apigateway.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }
-
Para usar o valor de tempo limite padrão de 29 segundos, deixe a opção Tempo limite padrão ativada. Para definir um tempo limite personalizado, selecione Tempo limite padrão e insira um valor de tempo limite entre
50
e29000
milissegundos. -
Escolha Criar método.
-