https://github.com/manjyot/properly-demo-serverless
A serverless implementation of a Typescript sample API with AWS Lambda, API Gateway, DynamoDB, Swagger, Express for routing and Jest for unit testing.
https://github.com/manjyot/properly-demo-serverless
aws-lambda dynamodb express jest serverless swagger typescript
Last synced: 2 months ago
JSON representation
A serverless implementation of a Typescript sample API with AWS Lambda, API Gateway, DynamoDB, Swagger, Express for routing and Jest for unit testing.
- Host: GitHub
- URL: https://github.com/manjyot/properly-demo-serverless
- Owner: manjyot
- Created: 2022-02-17T18:58:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-18T09:23:43.000Z (over 4 years ago)
- Last Synced: 2025-01-26T19:11:16.156Z (over 1 year ago)
- Topics: aws-lambda, dynamodb, express, jest, serverless, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 218 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serverless Sample API
A serverless implementation of a Typescript sample API with AWS Lambda, API Gateway, DynamoDB, Swagger, Express for routing and Jest for unit testing.
## Pre-requisites
- [Node.js](https://nodejs.org/)
- [Serverless CLI](https://serverless.com/)
## Available Endpoints
The API implements 3 CRUD routes - /homes, /authors and /books.
Authors and Books were implemented to demonstrate the model relationships.
## API Doc
OpenAPI doc using Swagger UI can be accessed at the following link:
[OpenAPI Doc](https://72srvwu9hj.execute-api.us-east-1.amazonaws.com/docs)
## Usage
Install dependencies with:
```
npm install
```
Configure AWS credentials:
```
export AWS_SECRET_ACCESS_KEY=
export AWS_ACCESS_KEY_ID=
```
Deploy with:
```
serverless deploy
```