make AWS API Gateway's Mapping Template testable
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
misc
test
.gitignore
.npmignore
CHANGELOG.md
LICENSE
README.md
example.js
index.js
package.json

README.md

api-gateway-mapping-template

make AWS API Gateway's Mapping Template testable

Image

Installation

npm install api-gateway-mapping-template

Usage

simple.js:

var mappingTemplate = require('api-gateway-mapping-template')

var vtl = '$input.json(\'$.data\')';
var payload = '{"data": {"url": "https://github.com/ToQoz/api-gateway-mapping-template"}}';

var result = mappingTemplate({template: vtl, payload: payload})
console.dir(result);

$ node ./simple.js
'{"url":"https://github.com/ToQoz/api-gateway-mapping-template"}'

Examples

API

var mappingTemplate = require('api-gateway-mapping-template')

mappingTemplate(parameters)

This function renders AWS API Gateway's Mapping Template by using given payload, params and context.

  • Arguments
    • parameters - required - map
      • template - required - String|Buffer
      • payload - required - String|Buffer
      • params - map
        • path - map<String, String|Number|Boolean|null>
        • querystring - map<String, String|Number|Boolean|null>
        • header - map<String, String|Number|Boolean|null>
      • context - map
        • indentity - map<String, String>
          • cognitoAuthenticationType - String
          • cognitoIdentityId - String
          • cognitoIdentityPoolId - String
          • sourceIp - String
          • user - String
          • userAgent - String
          • userArn - String
        • requestId - String
        • resourceId - String
        • resourcePath - String
        • stage - String
  • Return value
    • rendered template - String