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

swagger-lambda

v1.0.0

Published

Swagger Lambda Controller is an alternative solution to AWS API Gateway's lambda invokation built on NodeJS, Express, and the Swagger Tools Middleware

Downloads

139

Readme

swagger-lambda

Swagger Lambda is an alternative solution to AWS API Gateway's lambda invokation built on NodeJS, Express, and the Swagger Tools Middleware.

Installation

npm install --save swagger-lambda

/controllers/lambda.js

const swaggerLambda = require('swagger-lambda');

exports.invoke = swaggerLambda;

Configuration

See example for a more detailed implementation. The swagger-lambda controller can be configured through the swagger route definition, and by using environment variables. In all cases the properties defined in the swagger definition will be used instead of environment variables.

Swagger Route Configuration

  • x-swagger-router-controller: Name of lambda controller. Example lambda
  • operationId: Name of method to call. Example invoke
  • x-lambda-function-name: Required Name or ARN of the lambda function to invoke. Example getGreeting
  • x-lambda-function-alias: Controls which version of your lambda function to invoke. Default $LATEST
  • x-lambda-dryrun: Invoke the function call without executing the lambda function. Good for testing. Default false

swagger-lambda ENV variables

  • AWS_LAMBDA_ALIAS: Controls which version of your lambda function to invoke. Default $LATEST
  • AWS_LAMBDA_DRYRUN: Invoke the function call without executing the lambda function. Good for testing. Default false

Debugging

To debug the lambda controller set the environment variable DEBUG=swagger-lambda

Required AWS ENV variables

# AWS required params
AWS_PROFILE=my-account
# OR
AWS_ACCESS_KEY_ID=yourKey
AWS_SECRET_ACCESS_KEY=yourSecret

AWS_REGION=us-west-2

Example

In this example we will use Express and Swagger Tools to scaffold our API from our swagger.yml. First we need to create the lambda controller controllers/lambda.js. We then need to update our swagger.yml with x-swagger-router-controller, x-lambda-function-name, operationId. The swagger-lambda module will read the custom x-lambda-* properties to build the lambda invoke request.

/controllers/lambda.js

const swaggerLambda = require('swagger-lambda');

exports.invoke = swaggerLambda;

swagger.yml

swagger: '2.0'
info:
  version: 1.0.0
  title: Swagger Lambda Example
basePath: /api/v1
paths:
  /hello:
    get:
      x-swagger-router-controller: lambda
      x-lambda-function-name: getGreeting
      operationId: invoke
      summary: Returns greeting
      parameters:
        - name: name
          in: query
          type: string
      responses:
        200:
          description: Success

index.js

const express = require('express');
const swaggerTools = require('swagger-tools');
const yaml = require('js-yaml');
const fs = require('fs');
const path = require('path');

const { PORT = 3000 } = process.env;
const schema = yaml.safeLoad(
  fs.readFileSync(path.join(__dirname, 'swagger.yml'), 'utf8')
);
const app = express();

swaggerTools.initializeMiddleware(schema, middleware => {
  app.use(middleware.swaggerMetadata());
  app.use(middleware.swaggerValidator());
  app.use(
    middleware.swaggerRouter({
      controllers: path.join(__dirname, 'controllers')
    })
  );

  app.use(
    middleware.swaggerUi({
      apiDocs: '/api/v1/api-docs',
      swaggerUi: '/api/v1/docs'
    })
  );

  // Start the server on the specified port
  app.listen(PORT, () => {
    /* eslint no-console: 0 */
    console.log(`Server running on port ${PORT}`);
  });
});

Example Lambda Function

exports.handler = (event, context, callback) => {
  const { name } = event;

  callback(null, `Hello, ${name}`);
};