api-gateway-localdev's Introduction

api-gateway-localdev

simulate AWS API Gateway for dev in your local

Installation

npm install api-gateway-localdev

Usage

app.js:

var express = require('express');
var apiGatewayLocal = require('api-gateway-localdev');

var app = apiGatewayLocal(express(), [
  {
    lambda: require("./lambda").handler,
    method: "GET",
    path: "/users/{username}",
    responses: {
        "200": {
          "responseTemplates": {},
          "responseModels": {}
        },
        "404": {
          "selectionPattern": ".*404.*",
          "responseTemplates": {},
          "responseModels": {}
        }
    }
    requestTemplates: {
      "application/json": '{"username": "$input.params(\'username\')"}'
    },
  }
]);

app.listen(8000);

lambda.js:

exports.handler = function (event, context, callback) {
  callback(err, findUser(event.username));
}

function findUser(username) {
  // ...
}

$ node ./app.js

API

var apiGatewayLocal = require('api-gateway-localdev')

apiGatewayLocal(app, routes)

Arguments
- app - instance of express
- routes - Array<map>
  - lambda - Function
  - arn - String - The arn to use for context.invokedFunctionArn key to enable simulation of stages.
  - method - String
  - path - String
  - statusCode - Number
  - responses - map<String, map>
    - 'status code' e.g. "200"
      - selectionPattern - String
      - responseTemplates - map<String, String|Buffer>
      - responseModels - map<String, String|Buffer>
  - requestTemplates - map<String, String|Buffer>
Return value
- app

Recommend Projects