fix: decodes base64 requests (fixes #64); added form to index view to showcase POST/PUT; move example instructions to example/README.md; update example to Node.js 6.10; added app.local.js to easily run local express

Author: brettstack

README.md

@@ -18,45 +18,25 @@ exports.handler = (event, context) => awsServerlessExpress.proxy(server, event,
 
 [Package and create your Lambda function](http://docs.aws.amazon.com/lambda/latest/dg/nodejs-create-deployment-pkg.html), then configure a simple proxy API using Amazon API Gateway and integrate it with your Lambda function.
 
-## Example
+## Quick Start/Example
 
-In addition to a basic Lambda function and Express server, the `example` directory includes a [Swagger file](http://swagger.io/specification/), [CloudFormation template](https://aws.amazon.com/cloudformation/aws-cloudformation-templates/) with [Serverless Application Model (SAM)](https://github.com/awslabs/serverless-application-model), and helper scripts to help you set up and manage your application.
+Want to get up and running quickly? [Check out our example](example/README.md) which includes:
 
-### Steps for running the example
-This guide assumes you have already [set up an AWS account](http://docs.aws.amazon.com/AmazonSimpleDB/latest/DeveloperGuide/AboutAWSAccounts.html) and have the latest version of the [AWS CLI](https://aws.amazon.com/cli/) installed.
-
-1. From your preferred project directory: `git clone https://github.com/awslabs/aws-serverless-express.git && cd aws-serverless-express/example`.
-2. Run `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-bucket" --region="us-west-2" --function-name="my-function"`. This modifies `package.json`, `simple-proxy-api.yaml` and `cloudformation.yaml` with your account ID, bucket, region and function name (region defaults to `us-east-1` and 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 `package.json`, `simple-proxy-api.yaml` and `cloudformation.yaml` manually.
-3. Run `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.
-4. 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 `AwsServerlessExpressStack` stack, then click the `ApiUrl` value 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 `curl` commands.
-
-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:
-
-1. Copy the files in the `example` directory 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](#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).
-2. 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:
-
-1. Copy the following files from the `example` directory: `api-gateway-event.json`, `cloudformation.yaml`, `lambda.js`, and `simple-proxy-api.yaml`. Additionally, copy the `scripts` and `config` sections of `example/package.json` into 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](#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).
-2. From your existing project directory, run `npm install --save aws-serverless-express`.
-3. Modify `lambda.js` to import your own server configuration (eg. change `require('./app')` to `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.listen` callback, you can provide it as the second parameter in the `awsServerlessExpress.createServer` method).
-4. Modify the `CodeUri` property of the Lambda function resource in `cloudformation.yaml` to 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.
-5. Run `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 (`httpMethod`, `path`, `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.
+ - Lambda function
+ - Express server
+ [Swagger file](http://swagger.io/specification/)
+ - [Serverless Application Model (SAM)](https://github.com/awslabs/serverless-application-model)/[CloudFormation](https://aws.amazon.com/cloudformation/aws-cloudformation-templates/) template
+ - Helper scripts to configure, deploy, and manage your application
 
 ### Getting the API Gateway event object
 This package includes middleware to easily get the event object Lambda receives from API Gateway
 
 ```js
 const awsServerlessExpressMiddleware = require('aws-serverless-express/middleware')
 app.use(awsServerlessExpressMiddleware.eventContext())
+app.get('/', (req, res) => {
+  res.json(req.apiGateway.event)
+})
 ```
 
 ### Is AWS serverless right for my app?
@@ -72,12 +52,12 @@ app.use(awsServerlessExpressMiddleware.eventContext())
  - [Staging](http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html)
  - [SDK Generation](http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-generate-sdk.html)
  - [API Monitoring](http://docs.aws.amazon.com/apigateway/latest/developerguide/monitoring-cloudwatch.html)
+ - [Request Validation](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
+ - [Documentation](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html)
 
 #### Cons
 
- - Currently limited to Node.js 4.3 (LTS)
  - For apps that may not see traffic for several minutes at a time, you could see [cold starts](https://aws.amazon.com/blogs/compute/container-reuse-in-lambda/)
- - May be more expensive for high-traffic apps
  - Cannot use native libraries (aka [Addons](https://nodejs.org/api/addons.html)) unless you package your app on an EC2 machine running Amazon Linux
  - Stateless only
  - API Gateway has a timeout of 30 seconds, and Lambda has a maximum execution time of 5 minutes.

example/README.md

@@ -0,0 +1,36 @@
+## Example
+
+In addition to a basic Lambda function and Express server, the `example` directory includes a [Swagger file](http://swagger.io/specification/), [CloudFormation template](https://aws.amazon.com/cloudformation/aws-cloudformation-templates/) with [Serverless Application Model (SAM)](https://github.com/awslabs/serverless-application-model), and helper scripts to help you set up and manage your application.
+
+### Steps for running the example
+This guide assumes you have already [set up an AWS account](http://docs.aws.amazon.com/AmazonSimpleDB/latest/DeveloperGuide/AboutAWSAccounts.html) and have the latest version of the [AWS CLI](https://aws.amazon.com/cli/) installed.
+
+1. From your preferred project directory: `git clone https://github.com/awslabs/aws-serverless-express.git && cd aws-serverless-express/example`.
+2. Run `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 `package.json`, `simple-proxy-api.yaml` and `cloudformation.yaml` with your account ID, bucket, region and function name (region defaults to `us-east-1` and 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 `package.json`, `simple-proxy-api.yaml` and `cloudformation.yaml` manually.
+3. Run `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.
+4. 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 `AwsServerlessExpressStack` stack, then click the `ApiUrl` value 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 `curl` commands.
+
+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:
+
+1. Copy the files in the `example` directory 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](#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).
+2. 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:
+
+1. Copy the following files from the `example` directory: `api-gateway-event.json`, `cloudformation.yaml`, `lambda.js`, and `simple-proxy-api.yaml`. Additionally, copy the `scripts` and `config` sections of `example/package.json` into 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](#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).
+2. From your existing project directory, run `npm install --save aws-serverless-express`.
+3. Modify `lambda.js` to import your own server configuration (eg. change `require('./app')` to `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.listen` callback, you can provide it as the second parameter in the `awsServerlessExpress.createServer` method).
+4. Modify the `CodeUri` property of the Lambda function resource in `cloudformation.yaml` to 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.
+5. Run `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 (`httpMethod`, `path`, `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.
+
+## Node.js version
+
+This example was written against Node.js version 6.10

example/app.js

@@ -14,64 +14,64 @@ app.use(bodyParser.urlencoded({ extended: true }))
 app.use(awsServerlessExpressMiddleware.eventContext())
 
 app.get('/', (req, res) => {
-    res.render('index', {
-      apiUrl: `https://${req.apiGateway.event.headers.Host}/${req.apiGateway.event.requestContext.stage}`
-    })
+  res.render('index', {
+    apiUrl: req.apiGateway ? `https://${req.apiGateway.event.headers.Host}/${req.apiGateway.event.requestContext.stage}` : 'http://localhost:3000'
+  })
 })
 
 app.get('/sam', (req, res) => {
-    res.sendFile(`${__dirname}/sam-logo.png`)
+  res.sendFile(`${__dirname}/sam-logo.png`)
 })
 
 app.get('/users', (req, res) => {
-    res.json(users)
+  res.json(users)
 })
 
 app.get('/users/:userId', (req, res) => {
-    const user = getUser(req.params.userId)
+  const user = getUser(req.params.userId)
 
-    if (!user) return res.status(404).json({})
+  if (!user) return res.status(404).json({})
 
-    return res.json(user)
+  return res.json(user)
 })
 
 app.post('/users', (req, res) => {
-    const user = {
-        id: ++userIdCounter,
-        name: req.body.name
-    }
-    users.push(user)
-    res.status(201).json(user)
+  const user = {
+    id: ++userIdCounter,
+    name: req.body.name
+  }
+  users.push(user)
+  res.status(201).json(user)
 })
 
 app.put('/users/:userId', (req, res) => {
-    const user = getUser(req.params.userId)
+  const user = getUser(req.params.userId)
 
-    if (!user) return res.status(404).json({})
+  if (!user) return res.status(404).json({})
 
-    user.name = req.body.name
-    res.json(user)
+  user.name = req.body.name
+  res.json(user)
 })
 
 app.delete('/users/:userId', (req, res) => {
-    const userIndex = getUserIndex(req.params.userId)
+  const userIndex = getUserIndex(req.params.userId)
 
-    if(userIndex === -1) return res.status(404).json({})
+  if(userIndex === -1) return res.status(404).json({})
 
-    users.splice(userIndex, 1)
-    res.json(users)
+  users.splice(userIndex, 1)
+  res.json(users)
 })
 
 const getUser = (userId) => users.find(u => u.id === parseInt(userId))
 const getUserIndex = (userId) => users.findIndex(u => u.id === parseInt(userId))
 
 // Ephemeral in-memory data store
 const users = [{
-    id: 1,
-    name: 'Joe'
+  id: 1,
+  name: 'Joe'
 }, {
-    id: 2,
-    name: 'Jane'
+  id: 2,
+  name: 'Jane'
 }]
 let userIdCounter = users.length
 

example/app.local.js

@@ -0,0 +1,5 @@
+const app = require('./app')
+const port = 3000
+
+app.listen(port)
+console.log(`listening on http://localhost:${port}`)

example/cloudformation.yaml

@@ -57,7 +57,7 @@ Resources:
       Handler: lambda.handler
       MemorySize: 1024
       Role: !GetAtt LambdaExecutionRole.Arn
-      Runtime: nodejs4.3
+      Runtime: nodejs6.10
       Timeout: 30
       Events:
         ProxyApiRoot:

example/lambda.js

@@ -1,11 +1,11 @@
 'use strict'
 const awsServerlessExpress = require('aws-serverless-express')
 const app = require('./app')
+
 // NOTE: If you get ERR_CONTENT_DECODING_FAILED in your browser, this is likely
 // due to a compressed response (e.g. gzip) which has not been handled correctly
 // by aws-serverless-express and/or API Gateway. Add the necessary MIME types to
-// binaryMimeTypes, and to the x-amazon-apigateway-binary-media-types array in
-// simple-proxy-api.yaml, then redeploy (`npm run package-deploy`)
+// binaryMimeTypes below, then redeploy (`npm run package-deploy`)
 const binaryMimeTypes = [
   'application/javascript',
   'application/json',

example/simple-proxy-api.yaml

@@ -96,23 +96,7 @@ paths:
           application/json: "{\"statusCode\": 200}"
         type: mock
 x-amazon-apigateway-binary-media-types:
-  - application/javascript
-  - application/json
-  - application/octet-stream
-  - application/xml
-  - font/eot
-  - font/opentype
-  - font/otf
-  - image/jpeg
-  - image/png
-  - image/svg+xml
-  - text/comma-separated-values
-  - text/css
-  - text/html
-  - text/javascript
-  - text/plain
-  - text/text
-  - text/xml
+  - '*/*'
 definitions:
   Empty:
     type: object