https://github.com/hayanisaid/aws-lambda-nodejs-example
https://github.com/hayanisaid/aws-lambda-nodejs-example
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hayanisaid/aws-lambda-nodejs-example
- Owner: hayanisaid
- License: mit
- Created: 2021-09-22T02:31:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-22T19:34:24.000Z (over 3 years ago)
- Last Synced: 2025-04-01T20:51:18.731Z (about 1 month ago)
- Language: JavaScript
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
<<<<<<< HEAD
# AWS-Lambda-nodejs-example
=======
# Serverless Framework Node Express API on AWS
This template demonstrates how to develop and deploy a simple Node Express API service running on AWS Lambda using the traditional Serverless Framework.
## Anatomy of the template
This template configures a single function, `api`, which is responsible for handling all incoming requests thanks to configured `http` events. To learn more about `http` event configuration options, please refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/). As the events are configured in a way to accept all incoming requests, `express` framework is responsible for routing and handling requests internally. Implementation takes advantage of `serverless-http` package, which allows you to wrap existing `express` applications. To learn more about `serverless-http`, please refer to corresponding [GitHub repository](https://github.com/dougmoscrop/serverless-http).
## Usage
### Deployment
This example is made to work with the Serverless Framework dashboard, which includes advanced features such as CI/CD, monitoring, metrics, etc.
In order to deploy with dashboard, you need to first login with:
```
serverless login
```
install dependencies with:
```
npm install
```
and then perform deployment with:
```
serverless deploy
```
After running deploy, you should see output similar to:
```bash
Serverless: Packaging service...
Serverless: Excluding development dependencies...
Serverless: Creating Stack...
Serverless: Checking Stack create progress...
........
Serverless: Stack create finished...
Serverless: Uploading CloudFormation file to S3...
Serverless: Uploading artifacts...
Serverless: Uploading service aws-node-express-api.zip file to S3 (711.23 KB)...
Serverless: Validating template...
Serverless: Updating Stack...
Serverless: Checking Stack update progress...
.................................
Serverless: Stack update finished...
Service Information
service: aws-node-express-api
stage: dev
region: us-east-1
stack: aws-node-express-api-dev
resources: 12
api keys:
None
endpoints:
ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/
ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
functions:
api: aws-node-express-api-dev-api
layers:
None
```
_Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/).
### Invocation
After successful deployment, you can call the created application via HTTP:
```bash
curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/
```
Which should result in the following response:
```
{"message":"Hello from root!"}
```
Calling the `/hello` path with:
```bash
curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/hello
```
Should result in the following response:
```bash
{"message":"Hello from path!"}
```
If you try to invoke a path or method that does not have a configured handler, e.g. with:
```bash
curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/nonexistent
```
You should receive the following response:
```bash
{"error":"Not Found"}
```
### Local development
It is also possible to emulate API Gateway and Lambda locally by using `serverless-offline` plugin. In order to do that, execute the following command:
```bash
serverless plugin install -n serverless-offline
```
It will add the `serverless-offline` plugin to `devDependencies` in `package.json` file as well as will add it to `plugins` in `serverless.yml`.
After installation, you can start local emulation with:
```
serverless offline
```
To learn more about the capabilities of `serverless-offline`, please refer to its [GitHub repository](https://github.com/dherault/serverless-offline).
>>>>>>> 44e9278 (initial commit)