Configurar a integração de proxy com um recurso de proxy - Amazon API Gateway

Configurar a integração de proxy com um recurso de proxy

Para configurar uma integração de proxy em uma API do API Gateway com um recurso de proxy, execute as seguintes tarefas:

  • Crie um recurso de proxy com uma variável de caminho voraz de {proxy+}.

  • Defina o método ANY no recurso de proxy.

  • Integre o recurso e o método com um backend usando o tipo de integração HTTP ou Lambda.

nota

Variáveis de caminho vorazes, métodos ANY e tipos de integração de proxy são recursos independentes, embora sejam comumente usados em conjunto. Você pode configurar um método HTTP específico em um recurso voraz ou pode aplicar tipos de não integração de proxy a um recurso de proxy.

O API Gateway impõe certas restrições e limitações ao lidar com métodos com uma integração de proxy do Lambda ou uma integração de proxy HTTP. Para obter detalhes, consulte Notas importantes do Amazon API Gateway.

nota

Ao usar a integração de proxy com passagem direta, o API Gateway retornará o cabeçalho Content-Type:application/json padrão se o tipo de conteúdo de uma carga útil não for especificado.

Um recurso de proxy é mais poderoso quando integrado a um backend que usa uma integração de proxy HTTP ou uma integração de proxy do Lambda.

Integração de proxy HTTP com um recurso de proxy

A integração de proxy HTTP, designada por HTTP_PROXY na API REST do API Gateway, é para integrar uma solicitação de método com um endpoint HTTP de back-end. Com esse tipo de integração, o API Gateway simplesmente passa toda solicitação e resposta entre o front-end e o backend, sujeito a certas restrições e limitações.

nota

A integração de proxy HTTP oferece suporte para cabeçalhos de vários valores e strings de consulta.

Ao aplicar a integração de proxy HTTP a um recurso de proxy, você pode configurar sua API para expor uma parte ou toda uma hierarquia de endpoint do backend HTTP com uma única configuração de integração. Por exemplo, suponha que o backend do site esteja organizado em várias ramificações de nós de árvore no nó raiz (/site) como: /site/a0/a1/.../aN, /site/b0/b1/.../bM etc. Se você integrar o método ANY no recurso de proxy de /api/{proxy+} aos endpoints de backend com caminhos de URL de /site/{proxy}, uma única solicitação de integração poderá oferecer suporte a qualquer operação HTTP (GET, POST etc.) em qualquer [a0, a1, ..., aN, b0, b1, ...bM, ...]. Se você aplicar uma integração de proxy a um método HTTP específico, por exemplo, GET, em vez disso, a solicitação de integração resultante funcionará com as operações especificadas (ou seja, GET) em qualquer um desses nós de back-end.

Integração de proxy do Lambda com um recurso de proxy

A integração de proxy do Lambda, designada por AWS_PROXY na API REST do API Gateway, é para integrar uma solicitação de método com uma função do Lambda no back-end. Com esse tipo de integração, o API Gateway aplica um modelo de mapeamento padrão para enviar a solicitação inteira à função do Lambda e transforma a saída da função do Lambda em respostas HTTP.

De maneira semelhante, você pode aplicar a integração de proxy do Lambda a um recurso de proxy de /api/{proxy+} para configurar uma única integração para que uma função do Lambda de backend reaja individualmente a alterações em qualquer um dos recursos da API sob /api.