Merge pull request #131 from vlewin/master

Closes #130 Shared API Gateway and maxAge property support for HTTP Endpoints

Author: horike37

CHANGELOG.md

@@ -1,6 +1,6 @@
 # 0.2.0(08.01.2017)
 ## Breaking Changes
-The service name is added to the statemachin prefix.
+The service name is added to the statemachine prefix.
 This is because there is a possibility of conflict with the state machine deployed from another service without the service name.
 
 A state machine created with version 0.1 is not inherited. Please recreate it.
@@ -18,4 +18,4 @@ A state machine created with version 0.1 is not inherited. Please recreate it.
 Accidentally release(#1)
 
 # 0.1.1(29.12.2016)
-First Release
+First Release

README.md

@@ -169,6 +169,53 @@ stepFunctions:
       definition:
 ```
 
+#### Share API Gateway and API Resources
+
+You can [share the same API Gateway](https://serverless.com/framework/docs/providers/aws/events/apigateway/#share-api-gateway-and-api-resources) between multiple projects by referencing its REST API ID and Root Resource ID in serverless.yml as follows:
+
+```yml
+service: service-name
+provider:
+  name: aws
+  apiGateway:
+    # REST API resource ID. Default is generated by the framework
+    restApiId: xxxxxxxxxx
+    # Root resource, represent as / path
+    restApiRootResourceId: xxxxxxxxxx
+
+functions:
+  ...
+```
+If your application has many nested paths, you might also want to break them out into smaller services.
+
+However, Cloudformation will throw an error if we try to generate an existing path resource. To avoid that, we reference the resource ID:
+
+```yml
+service: service-a
+provider:
+  apiGateway:
+    restApiId: xxxxxxxxxx
+    restApiRootResourceId: xxxxxxxxxx
+    # List of existing resources that were created in the REST API. This is required or the stack will be conflicted
+    restApiResources:
+      /users: xxxxxxxxxx
+
+functions:
+  ...
+```
+
+Now we can define endpoints using existing API Gateway ressources
+
+```yml
+stepFunctions:
+  stateMachines:
+    hello:
+      events:
+        - http:
+            path: users/create
+            method: POST
+```
+
 #### Enabling CORS
 
 To set CORS configurations for your HTTP endpoints, simply modify your event configurations as follows:
@@ -210,6 +257,21 @@ stepFunctions:
 
 Configuring the cors property sets Access-Control-Allow-Origin, Access-Control-Allow-Headers, Access-Control-Allow-Methods,Access-Control-Allow-Credentials headers in the CORS preflight response.
 
+To enable the Access-Control-Max-Age preflight response header, set the maxAge property in the cors object:
+
+```yml
+stepFunctions:
+  stateMachines:
+    SfnApiGateway:
+      events:
+        - http:
+            path: /playground/start
+            method: post
+            cors:
+              origin: '*'
+              maxAge: 86400
+```
+
 #### Customizing request body mapping templates
 
 The plugin generates default body mapping templates for `application/json` and `application/x-www-form-urlencoded` content types. If you'd like to add more content types or customize the default ones, you can do so by including them in `serverless.yml`:

lib/deploy/events/apiGateway/cors.js

@@ -12,6 +12,7 @@ module.exports = {
       const corsMethodLogicalId = this.provider.naming
         .getMethodLogicalId(resourceName, 'options');
 
+      // TODO remove once "origins" config is deprecated
       let origin = config.origin;
       if (config.origins && config.origins.length) {
         origin = config.origins.join(',');
@@ -24,6 +25,16 @@ module.exports = {
         'Access-Control-Allow-Credentials': `'${config.allowCredentials}'`,
       };
 
+      // Enable CORS Max Age usage if set
+      if (_.has(config, 'maxAge')) {
+        if (_.isInteger(config.maxAge) && config.maxAge > 0) {
+          preflightHeaders['Access-Control-Max-Age'] = `'${config.maxAge}'`;
+        } else {
+          const errorMessage = 'maxAge should be an integer over 0';
+          throw new this.serverless.classes.Error(errorMessage);
+        }
+      }
+
       if (_.includes(config.methods, 'ANY')) {
         preflightHeaders['Access-Control-Allow-Methods'] =
           preflightHeaders['Access-Control-Allow-Methods']
@@ -43,10 +54,11 @@ module.exports = {
               RequestTemplates: {
                 'application/json': '{statusCode:200}',
               },
+              ContentHandling: 'CONVERT_TO_TEXT',
               IntegrationResponses: this.generateCorsIntegrationResponses(preflightHeaders),
             },
             ResourceId: resourceRef,
-            RestApiId: { Ref: this.apiGatewayRestApiLogicalId },
+            RestApiId: this.provider.getApiGatewayRestApiId(),
           },
         },
       });