api-gateway-mapping-template

0.0.8 • Public • Published

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

/api-gateway-mapping-template/

    Package Sidebar

    Install

    npm i api-gateway-mapping-template

    Weekly Downloads

    102

    Version

    0.0.8

    License

    MIT

    Unpacked Size

    34.2 kB

    Total Files

    11

    Last publish

    Collaborators

    • toqoz