Path parameters ignored by AWS API Gateway using proxy+

Question

I have a REST API on the AWS API Gateway. It has one resource, /{proxy+}, that is configured with the ANY method. The integration request is setup to be a VPC_PROXY, meaning its using a VPC Link. The VPC link is to a network load balancer that is fronting an app I have running on an ECS cluster using Fargate.

When using the console's option to test the API, I can confirm that requests are reaching my app but the resource being requested is always / according to my logging. If I attempt to set the {proxy} value in the method test screen on the console, it seems like my app only ever gets requests for /. If I set {proxy} to something like widget/5, the response I receive is as if I was request /.

I'm wondering if there is some way to troubleshoot this, scouring the AWS documentation I can't figure out where I'm going wrong with my setup.

Kaustubh Khavnekar · Accepted Answer · 2022-01-15 09:25:33Z

5

In your integration, the endpoint URL should be http://loadbalancerurl/{proxy}. I couldn't find any documentation specifically for VPC Link integration, but there is a tutorial for HTTP proxy integration which has similar steps.

If you are using openapi spec, the integration section would look something like this:

x-amazon-apigateway-integration:
  uri: "http://loadbalancerurl/{proxy}"
  responses:
    default:
      statusCode: "200"
  requestParameters:
    integration.request.path.proxy: "method.request.path.proxy"
  passthroughBehavior: "when_no_match"
  connectionType: "VPC_LINK"
  connectionId: "your-vpclink-id"
  httpMethod: "ANY"
  type: "http_proxy"

When using the console, integration.request.path.proxy: "method.request.path.proxy" mapping was added automatically when I added {proxy} to my endpoint URL.

answered Jan 15, 2022 at 9:25

Kaustubh Khavnekar

2,9735 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

DiviNik · Accepted Answer · 2022-06-29 17:01:27Z

3

What works for me is by adding the following properties:

Resources:
  APIGWProxyMethod:
    Type: AWS::ApiGateway::Method
    Properties:
      RequestParameters: 
        method.request.path.proxy: true # enable proxy
      Integration:
        RequestParameters:
          integration.request.path.proxy: method.request.path.proxy # map method proxy param to integration proxy param
      ... # the rest of integration property
    ... # other properties

Articles that helped:

answered Jun 29, 2022 at 17:01

DiviNik

1613 bronze badges

1 Comment

gratinierer Feb 21 at 17:33

perfect hint! this is poorly documented. coming from cdk with

Invalid mapping expression specified: integration.request.path.proxy, Invalid mapping expression specified: method.request.path.proxy]

here you find the correct order of the parameters. Thanks!

Collectives™ on Stack Overflow

Path parameters ignored by AWS API Gateway using proxy+

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related