:doc: wrong API type for template compatability #386
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
So if you follow along with these instructions and actually try to test the endpoint via postman or curl you will realize that you will get a server error because the lambda function is failing when trying to parse the event json data for "httpMethod". The "httpMethod" key will only be found in events generated by API gateway when it is configured as a REST API instead of an HTTP API. You can see below the differences but basically, the microservice lambda template for acting on the DynamoDB resource is set up to work out of the box for REST API gateways and not HTTP APIs. See below for comparing the body of the HTTP API vs REST API.
HTTP API Event Data Payload structure:
=============================================================
```
"requestContext": {
"accountId": "391741500388",
"apiId": "lh8rxrmng8",
"domainName": "lh8rxrmng8.execute-api.us-east-1.amazonaws.com",
"domainPrefix": "lh8rxrmng8",
"http": {
"method": "GET",
.
.
.
```
=============================================================
API Event Data Payload structure:
=============================================================
```
"requestContext": {
"resourceId": "q9c11x",
"resourcePath": "/lambda-microservice2",
"httpMethod": "GET",
.
.
.
```
=============================================================
|
Thanks for the PR, and apologies for the delay. This tutorial has since been retired. Please take a look at the updated tutorial-- |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explination
So if you follow along with these instructions for the "Create a simple microservice using Lambda and API Gateway" tutorial and actually try to test the endpoint via postman or curl you will realize that you will get a server error because the lambda function is failing when trying to parse the event json data for "httpMethod". The "httpMethod" key will only be found in events generated by API gateway when it is configured as a REST API instead of an HTTP API. You can see below the differences. Basically, the microservice lambda template code which performs actions on the DynamoDB resource is set up to work out of the box for REST API gateway body format and not HTTP API's. See below for comparing the body of the HTTP API vs REST API.
HTTP API Event Data Payload structure:
API Event Data Payload structure:
Issue #, if available:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.