feat(dynamodb): add response template support for dynamodb

Author: Jeremiah Langner

README.md

@@ -26,6 +26,7 @@ This Serverless Framework plugin supports the AWS service proxy integration feat
   - [SNS](#sns)
     - [Customizing responses](#customizing-responses-2)
   - [DynamoDB](#dynamodb)
+    - [Customizing responses](#customizing-responses-3)
   - [EventBridge](#eventbridge)
 - [Common API Gateway features](#common-api-gateway-features)
   - [Enabling CORS](#enabling-cors)
@@ -446,7 +447,7 @@ custom:
           template:
             # `success` is used when the integration response is 200
             success: |-
-              { "message: "accepted" }
+              { "message": "accepted" }
             # `clientError` is used when the integration response is 400
             clientError: |-
               { "message": "there is an error in your request" }
@@ -568,6 +569,40 @@ curl -XPUT https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/dynamodb/<has
  -H 'Content-Type:application/json'
 ```
 
+#### Customizing responses
+
+##### Simplified response template customization
+
+You can get a simple customization of the responses by providing a template for the possible responses. The template returns the same kind of response for both `application/json` and `application/x-www-form-urlendcoded`.
+
+```yml
+custom:
+  apiGatewayServiceProxies:
+    - dynamodb:
+        path: /dynamodb
+        method: get
+        tableName: { Ref: 'YourTable' }
+        hashKey:
+          queryStringParam: id # use query string parameter
+          attributeType: S
+        rangeKey:
+          queryStringParam: sort
+          attributeType: S
+        action: GetItem
+        cors: true
+        response:
+          template:
+            # `success` is used when the integration response is 200
+            success: |-
+              #set($item = $input.path('$.Item'))
+              { "Item": $item }
+            # `clientError` is used when the integration response is 400
+            clientError: |-
+              { "message": "there is an error in your request" }
+            # `serverError` is used when the integration response is 500
+            serverError: |-
+              { "message": "there was an error handling your request" }
+```
 
 ### EventBridge
 

lib/apiGateway/schema.js

@@ -300,7 +300,8 @@ const proxiesSchemas = {
       condition: Joi.string(),
       hashKey: dynamodbDefaultKeyScheme.required(),
       rangeKey: dynamodbDefaultKeyScheme,
-      request
+      request,
+      response: extendedResponse
     })
   }),
   eventbridge: Joi.object({

lib/package/dynamodb/compileMethodsToDynamodb.js

@@ -61,27 +61,64 @@ module.exports = {
       RequestTemplates: this.getDynamodbIntegrationRequestTemplates(http)
     }
 
-    const integrationResponse = {
-      IntegrationResponses: [
-        {
-          StatusCode: 200,
-          SelectionPattern: '2\\d{2}',
-          ResponseParameters: {},
-          ResponseTemplates: this.getDefaultDynamodbResponseTemplates(http)
-        },
-        {
-          StatusCode: 400,
-          SelectionPattern: '4\\d{2}',
-          ResponseParameters: {},
-          ResponseTemplates: {}
-        },
-        {
-          StatusCode: 500,
-          SelectionPattern: '5\\d{2}',
-          ResponseParameters: {},
-          ResponseTemplates: {}
-        }
-      ]
+    let integrationResponse
+
+    if (_.get(http.response, 'template.success')) {
+      // support a simplified model
+      integrationResponse = {
+        IntegrationResponses: [
+          {
+            StatusCode: 200,
+            SelectionPattern: 200,
+            ResponseParameters: {},
+            ResponseTemplates: this.getSnsIntegrationResponseTemplate(http, 'success')
+          },
+          {
+            StatusCode: 400,
+            SelectionPattern: 400,
+            ResponseParameters: {},
+            ResponseTemplates: this.getSnsIntegrationResponseTemplate(http, 'clientError')
+          },
+          {
+            StatusCode: 500,
+            SelectionPattern: 500,
+            ResponseParameters: {},
+            ResponseTemplates: this.getSnsIntegrationResponseTemplate(http, 'serverError')
+          }
+        ]
+      }
+    } else if (_.isArray(http.response)) {
+      integrationResponse = {
+        IntegrationResponses: http.response.map((i) => ({
+          StatusCode: i.statusCode,
+          SelectionPattern: i.selectionPattern || i.statusCode,
+          ResponseParameters: i.responseParameters || {},
+          ResponseTemplates: i.responseTemplates || {}
+        }))
+      }
+    } else {
+      integrationResponse = {
+        IntegrationResponses: [
+          {
+            StatusCode: 200,
+            SelectionPattern: '2\\d{2}',
+            ResponseParameters: {},
+            ResponseTemplates: this.getDefaultDynamodbResponseTemplates(http, 'success')
+          },
+          {
+            StatusCode: 400,
+            SelectionPattern: '4\\d{2}',
+            ResponseParameters: {},
+            ResponseTemplates: {}
+          },
+          {
+            StatusCode: 500,
+            SelectionPattern: '5\\d{2}',
+            ResponseParameters: {},
+            ResponseTemplates: {}
+          }
+        ]
+      }
     }
 
     this.addCors(http, integrationResponse)
@@ -143,6 +180,17 @@ module.exports = {
     }
   },
 
+  getDynamodbResponseTemplates(http, statusType) {
+    const template = _.get(http, ['response', 'template', statusType])
+    return Object.assign(
+      {},
+      template && {
+        'application/json': template,
+        'application/x-www-form-urlendcoded': template
+      }
+    )
+  },
+
   getDefaultDynamodbResponseTemplates(http) {
     if (http.action === 'GetItem') {
       return {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "serverless-apigateway-service-proxy",
   "version": "2.0.0",
-  "description": "The Serverless Framewrok plugin for supporting AWS service proxy integration of API Gateway",
+  "description": "The Serverless Framework plugin for supporting AWS service proxy integration of API Gateway",
   "main": "lib/index.js",
   "scripts": {
     "lint": "eslint .",