https://github.com/jareechang/api-gateway-lamba
API gateway with lambda using Node.js 12.x
https://github.com/jareechang/api-gateway-lamba
api-gateway aws cloudwatch iam infra infrastructure infrastructure-as-code lambda lambda-functions nodejs serverless
Last synced: about 2 months ago
JSON representation
API gateway with lambda using Node.js 12.x
- Host: GitHub
- URL: https://github.com/jareechang/api-gateway-lamba
- Owner: Jareechang
- Created: 2020-08-14T03:13:54.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-15T19:14:36.000Z (almost 6 years ago)
- Last Synced: 2026-03-04T04:13:37.626Z (4 months ago)
- Topics: api-gateway, aws, cloudwatch, iam, infra, infrastructure, infrastructure-as-code, lambda, lambda-functions, nodejs, serverless
- Language: HCL
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## API gateway with Lambda demo on Node.js
Terraform setup of API gateway with Lambda running on Node.js.
**Quick demo few AWS services and concepts:**
- AWS IAM roles (Lambda and API gateway)
- AWS API gateway
- Lambda CW logs setup
- Lambda S3 store
- Terraform (>= v0.12.24)
**Folder structure:**
```sh
pet/
├── create.js - create new pet
├── get.js - get pet by id
└── list.js - list pets
```
### Sections
1. [Quick Start](#quick-start)
2. [Lambda Versioning](#lambda-versioning)
3. [Testing The API](#testing-the-api)
- GET `/pets` [List Pets](#list-pets)
- GET `/pet/:id` [Get pet by ID](#get-pet-by-id)
- POST `/pets` [Create new pet](#create-pet)
### Quick Start
1. Setup the environment
```sh
// create a file called setup-env.sh
export AWS_ACCESS_KEY_ID=
export AWS_SECRET_ACCESS_KEY=
export AWS_DEFAULT_REGION=us-east-1
. ./setup-env.sh
```
2. Create Infrastructure
```sh
terraform init
terraform plan
terraform apply -auto-approve
# init the dist files for lambda
yarn run version:patch
```
3. See Instructions below for testing the api.
### Lambda Versioning
Created custom versioning of lambda code changes via node.js scripts. The gist of it is when versioning is done through the npm (patch, minor, major) the terraform configuration will pick up changes and push changes based on the version in the `package.json`.
**Publishing:**
```sh
// Patch
yarn run version:patch
// Minor
yarn run version:minor
// Major
yarn run version:major
```
**Deploying:**
```
terraform plan
terraform apply -auto-approve
```
### Testing The API
#### List Pets
**Request:**
```sh
curl -X GET "/pets"
```
**Response:**
```sh
[
{
"id": 1,
"price": 249.99,
"type": "dog"
},
{
"id": 2,
"price": 124.99,
"type": "cat"
},
{
"id": 3,
"price": 0.99,
"type": "fish"
}
]
```
#### Get pet by ID:
**Request:**
```
curl -X GET "/pets/:petId"
```
**Response:**
```sh
curl -X GET "/pets/1"
[
{
"id": 1,
"price": 249.99,
"type": "dog"
}
]
```
#### Create pet:
**Note:** All the data is in memory so there will be no persistence between lambda requests (ie. creating this endpoint will not update the list `pets` endpoint)
**Request:**
```
curl -X POST "/stage/pets" \
--data-raw '{
"pet": {
"id": {
"id": 4,
"type": "Snake",
"price": 399.99
}
}
}'
```
**Response:**
```sh
[
{
"id": 1,
"type": "dog",
"price": 249.99
},
{
"id": 2,
"type": "cat",
"price": 124.99
},
{
"id": 3,
"type": "fish",
"price": 0.99
},
{
"id": {
"id": 4,
"type": "Snake",
"price": 399.99
}
}
]
```