ssugimoto / momento-serverless-tutorial

Adding a cache to a serverless application

This is the code repository for a tutorial on adding a cache to a serverless application. Be sure to refer to that tutorial to walk through the steps of deploying a serverless application, then adding caching to improve the performance of your application.

Most of the details of the application are explained in the tutorial. However, you can use this repository to take a deeper look at some of the code aspects that are not discussed in depth in the tutorial.

Specifically, look at the following areas for additional detail:

• The src/handlers README for information on the Lambda function handlers;
• The src/accounts README for details on the Accounts service;
• The src/clients README for information about API clients.

Deploying

To deploy this service, you must have the Serverless Framework installed. You can install it with the following command:

npm install -g serverless

You will also need to have AWS credentials available in your environment. See here to see how to set up your credentials.

Once you have configured your environment, you can deploy the application using the following command:

serverless deploy

The Serverless Framework will build and deploy your application to AWS. Following the deploy, you should see output indicating the URL endpoints that can be used to access your application:

✔ Service deployed to stack momento-serverless-tutorial-dev (58s)

endpoints:
  POST - https://${apiId}.execute-api.us-east-1.amazonaws.com/dev/users
  POST - https://${apiId}.execute-api.us-east-1.amazonaws.com/dev/organizations
  POST - https://${apiId}.execute-api.us-east-1.amazonaws.com/dev/organizations/{organization}/members
  GET - https://${apiId}.execute-api.us-east-1.amazonaws.com/dev/organizations/{organization}/members/{username}
functions:
  createUser: momento-serverless-tutorial-dev-createUser (21 kB)
  createOrganization: momento-serverless-tutorial-dev-createOrganization (21 kB)
  addUserToOrganization: momento-serverless-tutorial-dev-addUserToOrganization (21 kB)
  userInOrganization: momento-serverless-tutorial-dev-userInOrganization (21 kB)

Check out the tutorial to see how to exercise these endpoints.

In the collections/ directory, there are exported collections for both Postman and Insomnia. For each, be sure to set the endpoint variable in your environment to the base URL for your API.