In addition to a basic Lambda function and Express server, the
example directory includes a Swagger file, CloudFormation template with Serverless Application Model (SAM), and helper scripts to help you set up and manage your application.
Steps for running the example
- From your preferred project directory:
git clone https://github.com/awslabs/aws-serverless-express.git && cd aws-serverless-express/example.
npm run config -- --account-id="<accountId>" --bucket-name="<bucketName>" [--region="<region>" --function-name="<functionName>"]to configure the example, eg.
npm run config -- --account-id="123456789012" --bucket-name="my-unique-bucket". This modifies
cloudformation.yamlwith your account ID, bucket, region and function name (region defaults to
us-east-1and function name defaults to
AwsServerlessExpressFunction). If the bucket you specify does not yet exist, the next step will create it for you. This step modifies the existing files in-place; if you wish to make changes to these settings, you will need to modify
npm run setup(Windows users:
npm run win-setup) - this installs the node dependencies, creates an S3 bucket (if it does not already exist), packages and deploys your serverless Express application to AWS Lambda, and creates an API Gateway proxy API.
- After the setup command completes, open the AWS CloudFormation console https://console.aws.amazon.com/cloudformation/home and switch to the region you specified. Select the
AwsServerlessExpressStackstack, then click the
ApiUrlvalue under the Outputs section - this will open a new page with your running API. The API index lists the resources available in the example Express server (
app.js), along with example
See the sections below for details on how to migrate an existing (or create a new) Node.js project based on this example. If you would prefer to delete AWS assets that were just created, simply run
npm run delete-stack to delete the CloudFormation Stack, including the API and Lambda Function. If you specified a new bucket in the
config command for step 1 and want to delete that bucket, run
npm run delete-bucket.
Creating or migrating a Node.js project based on the example
To use this example as a base for a new Node.js project:
- Copy the files in the
exampledirectory into a new project directory (
cp -r ./example ~/projects/my-new-node-project). If you have not already done so, follow the steps for running the example (you may want to first modify some of the resource names to something more project-specific, eg. the CloudFormation stack, Lambda function, and API Gateway API).
- After making updates to
app.js, simply run
npm run package-deploy(Windows users:
npm run win-package-deploy).
To migrate an existing Node server:
- Copy the following files from the
simple-proxy-api.yaml. Additionally, copy the
example/package.jsoninto your existing
package.json- this includes many helpful commands to manage your AWS serverless assets and perform basic local simulation of API Gateway and Lambda. If you have not already done so, follow the steps for running the example (be sure to copy over
scripts/configure.js. You may want to first modify some of the resource names to something more project-specific, eg. the CloudFormation stack, Lambda function, and API Gateway API).
- From your existing project directory, run
npm install --save aws-serverless-express.
lambda.jsto import your own server configuration (eg. change
require('./server')). You will need to ensure you export your app configuration from the necessary file (eg.
module.exports = app). This library takes your app configuration and listens on a Unix Domain Socket for you, so you can remove your call to
app.listen()(if you have a
server.listencallback, you can provide it as the second parameter in the
- Modify the
CodeUriproperty of the Lambda function resource in
cloudformation.yamlto point to your application directory (e.g.
CodeUri: ./src). If you are using a build tool (e.g. Gulp, Grunt, Webpack, Rollup, etc.), you will instead want to point to your build output directory.
npm run package-deploy(Windows users:
npm run win-package-deploy) to package and deploy your application.
To perform a basic, local simulation of API Gateway and Lambda with your Node server, update
api-gateway-event.json with some values that are valid for your server (
body etc.) and run
npm run local. AWS Lambda uses NodeJS 4.3 LTS, and it is recommended to use the same version for testing purposes.
If you need to make modifications to your API Gateway API, modify
simple-proxy-api.yaml and run
npm run package-deploy. If your API requires CORS, be sure to modify the two
options methods defined in the Swagger file, otherwise you can safely remove them. To modify your other AWS assets, make your changes to
cloudformation.yaml and run
npm run package-deploy. Alternatively, you can manage these assets via the AWS console.
This example was written against Node.js version 6.10