https://github.com/serverless/event-gateway-getting-started
Walkthrough application for using the Event Gateway. -- https://www.serverless.com
https://github.com/serverless/event-gateway-getting-started
Last synced: about 1 month ago
JSON representation
Walkthrough application for using the Event Gateway. -- https://www.serverless.com
- Host: GitHub
- URL: https://github.com/serverless/event-gateway-getting-started
- Owner: serverless
- License: apache-2.0
- Created: 2018-04-06T20:28:47.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-04T17:29:26.000Z (almost 7 years ago)
- Last Synced: 2025-04-18T07:51:32.344Z (about 2 months ago)
- Language: JavaScript
- Size: 50.8 KB
- Stars: 50
- Watchers: 31
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Event Gateway REST API
This example shows a simple way to deploy a REST API via the Event Gateway and AWS Lambda. It uses the hosted version provided by Serverless, Inc. -- [Sign up here](https://dashboard.serverless.com)!
This service will deploy three functions:
- `createUser`: an HTTP endpoint for creating and storing a User in a DynamoDB table;
- `getUser`: an HTTP endpoint for retrieving a User from DynamoDB; and
- `emailUser`: a function that is triggered by a `user.created` event and pretends to email the user with a welcome message.
The `createUser` function allows you to create a new User by sending a JSON payload to `/users`, and the `getUser` function lets you retrieve that User by making a GET request to `/users/{id}`.
In the `createUser` function, we're using the [Event Gateway SDK](https://github.com/serverless/event-gateway-sdk) to emit a custom event of `user.created` into the Event Gateway. You can then subscribe functions to react to this custom event. The `emailUser` function is subscribed to this event as an example -- imagine a Marketing department that wants to handle emails.
Let's get started!
## Quick-Start
Follow this [guide](https://github.com/serverless/platform/blob/master/docs/getting-started.md) to get the Serverless Framework & Event Gateway set up.
Clone this repository, `cd` into it and run `npm i`
Make sure you have created an Application in the [Serverless Dashboard](https://dashboard.serverless.com) and filled in your `tenant` and `app` in your `serverless.yml` file.
```yaml
# serverless.yml
tenant: mytenant # Insert your tenant
app: demos # Insert your app
service: v1-eg-rest-api # Come up with a service name
```
Deploy your service
```bash
$ serverless deploy
```
Create a new user by hitting the createUser endpoint:
```bash
$ APP=""
$ curl -X POST -H "Content-Type: application/json" https://${APP}/users \
--data '{
"id": "10",
"firstName": "Donald",
"lastName": "Duck",
"email": "[email protected]"
}'
# {"id":10,"firstName":"Donald","lastName":"Duck","email":"[email protected]"}
```
You can now retrieve your user by using the getUser endpoint:
```bash
$ APP=""
$ curl -X GET https://${APP}/users/10
# {"id":"10","email":"[email protected]","firstName":"Donald","lastName":"Duck"}
```
In your createUser code, it emits a `user.created` event to the Event Gateway, which triggers the `emailUser` function, which then emits a `email.sent` event. You can check the logs for the Event Gateway in the [Dashboard](https://dashboard.serverless.com), just navigate to your Service and click the "logs" tab.
## Additional Resources:
- [Serverless Platform Docs](https://github.com/serverless/platform)
- [Event Gateway plugin](https://github.com/serverless/serverless-event-gateway-plugin) for the Serverless Framework
- [Event Gateway SDK](https://github.com/serverless/event-gateway-sdk) for interacting with the Event Gateway in your application code