npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

api-gateway-lambda

v1.0.2

Published

This is a javascript library that eases the process of deployment of AWS Lambda and API Gateway.

Downloads

8

Readme

Lambda and Api Gateway deployment

'api-gateway-lambda' is a library that eases the process of deployment of AWS Lambda and API Gateway.

It takes the necessary parameters from a config.json file and swagger.json(For API-Gateway).

Getting Started.

Prerequisites.

  • Node.js (> v6.9.2)
  • AWS credentials should be stored in the environment variables.

Installation.

npm install api-gateway-lambda --save

Using it in your code.

  • If you have your config.json and swagger.json in a config folder at the root of your project:
const deploymentLibrary = require('api-gateway-lambda')();

deploymentLibrary.deployLambda();
deploymentLibrary.deployAPIGateWay();
  • You can specify the relative path of the config folder:
const deploymentLibrary = require('api-gateway-lambda')('/dist/config'); 
//if config folder is in a folder dist sitting at the root of your project.

deploymentLibrary.deployLambda();
deploymentLibrary.deployAPIGateWay();
  • These functions return promises in case you want to synchronize their execution.

deploymentLibrary.deployLambda()
  .then(result => console.log(result),
        error => console.log(error));

Important Files and Definition

The library takes the configuration for deployment from the config.json file.

config.json

{
 "LambdaName": "test-node",
 "APIGatewayName": "test-node",
 "s3BucketName": "test-node.15-6-17",
 "Role": "<IAM Role of ApiGateway Allowing access to Lambda>",
 "MemorySize": 128,
 "Runtime": "nodejs6.10",
 "Timeout": 10,
 "Handler": "index.handler",
 "SubnetIds": [
   "subnet-********"
 ],
 "SecurityGroupIds": [
   "sg-********"
 ],
 "filePath": "./src/FunctionName", 
 "env": {
   "PROD": {
     "envName": "PROD",
     "s3Path": "lambdaDeploymentPackage/PROD/test-node.zip",
     "stageName": "PROD",
     "aliasName": "PROD",
     "StageVariables": {
     }
   }
 }
}
  • Configuration parameters for Lambda:
{
  "LambdaName": "test-node",
  "s3BucketName": "test-node.15-6-17",
  "Role": "<IAM Role of ApiGateway Allowing access to Lambda>",
  "MemorySize": 128,
  "Runtime": "nodejs6.10",
  "Timeout": 10,
  "Handler": "index.handler",
  "SubnetIds": [
    "subnet-********"
  ],
  "SecurityGroupIds": [
    "sg-********"
  ],
  "filePath": "./src/FunctionName", 
  "env": {
    "PROD": {
      "envName": "PROD",
      "s3Path": "lambdaDeploymentPackage/PROD/test-node.zip",
      "aliasName": "PROD"
    }
  }
}
  • Configurations for API Gateway:
{
  "APIGatewayName": "test-node",
  "env": {
    "PROD": {
      "envName": "PROD",
      "stageName": "PROD",
      "aliasName": "PROD",
      "StageVariables": {
      }
    }
  }
}
  • For Deployment of API Gateway a swagger documentation is required.

swagger.json - x-amazon-apigateway-integration

{
"x-amazon-apigateway-integration": {
          "credentials": "<IAM Role of ApiGateway Allowing access to Lambda>",
          "httpMethod": "post",
          "type": "aws",
          "uri": "arn:aws:apigateway:<aws-region>:lambda:path/2015-03-31/functions/arn:aws:lambda:<aws-region>:<aws-account-number>:function:<function-name>:<alias-name>/invocations",
          "requestTemplates": {
            "application/json": "{\n \"end\": \"$input.params('end')\"\n}"
          },
          "responses": {
            "default": {
              "statusCode": 200
            },
            ".*BadRequest.*": {
              "statusCode": 400
            },
            ".*InternalServerError.*": {
              "statusCode": 500
            }
          }
        }
}