This is a highly opinionated RESTful API microservice template for AWS Lambda.
- Serverless framework
- Serverless express app
- Serverless webpack
- Swagger API Documentation
- JSON API specs
- Dot ENV
- AWS Lambda
- AWS API Gateway
- AWS SSM Parameter Store
- AWS X-Ray
npm install
Setup your local environment with .env
cat .env.example > .envnpm start
npm run testfor lint + unit testsnpm run test:unitfor unit tests only
npm run build
npm run deploy
Configure your .env file with the deployed resources
API_KEY=<API Gateway Key>API_URL=<API Gateway Url>npm run test:integrationfor integration tests
- Document deployment instructions
- Document the use of SSM Parameter store
- Document CI builds