Defining API path with query string Serverless HTTP API (API Gateway v2)

Question

How can I define the path in serverless.yml with more than one query parameter using HTTP API (API Gateway v2) so that the endpoint looks like the following:

https://example.com/rest/endpoint?id=$id&tag=$tag

serverless.yml

 dfsPostback: 
    handler:  handlers/result.main 
    events:
      - httpApi:
          path: /dfs-pingback  // need help here 
          method: get

I tried with

path: /dfs-pingback?id={id}&tag={tag}

deployment failed

you dont need to specify query strings in the path. however path parameters will need to. they. will be sent in the event object — cmgchess
– cmgchess, Commented Jul 5, 2022 at 6:54

pgrzesik · Accepted Answer · 2022-07-06 12:02:20Z

3

There is no need to specify the query parameters in the path. You should be able to access all passed query params in your event handler.

answered Jul 6, 2022 at 12:02

pgrzesik

2,44716 silver badges18 bronze badges

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

1 Comment

Muhammad Uzair Over a year ago

I just want to add that, you can read event.queryStringParameters (object) containing your params, but if no param is provided then event.queryStringParameters (null), so make sure to check type first before destructuring or reading properties.

Collectives™ on Stack Overflow

Defining API path with query string Serverless HTTP API (API Gateway v2)

serverless.yml

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

serverless.yml

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related