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

serverless-plugin-swagger-api

v1.1.0

Published

Define your API Endpoints in OpenAPI format (swagger) and create APIGW integration automatically

Downloads

208

Readme

Serverless plugin Swagger API

Create severless function events from swagger definition.

Install

npm i -D serverless-plugin-swagger-api

Usage:

serverless.yml

Add Swagge file to custom.swaggerApi.swagger

custom:
  swaggerApi:
    swagger: ${file(swagger.yml)}

functions:
  ExampleLambda:
    handler: src/example.js

swagger.yml

Add x-attr-serverless to your swagger path definition

swagger: "2.0"
schemes:
- "https"
info:
  description: "Serverless Plugin Swagger API test yml"
  version: "1.0.0"
  title: "Serverless Plugin Swagger API"
paths:
  /hello:
    get:
      produces:
      - "application/json"
      responses:
        200:
          description: "200 response"
          schema:
            $ref: "#/definitions/Empty"
      x-attr-serverless:
        functionName: ExampleLambda # LambdaFunction in serverless.yml
        cors: true # Turn on CORS for this endpoint, but don't forget to return the right header in your response
        private: true # Requires clients to add API keys values in the `x-api-key` header of their request
        authorizer: # An AWS API Gateway custom authorizer function
          name: authorizerFunc # The name of the authorizer function (must be in this service)
          arn: xxx:xxx:Lambda-Name # Can be used instead of name to reference a function outside of service
          resultTtlInSeconds: 0
          identitySource: method.request.header.Authorization
          identityValidationExpression: someRegex
          type: token # token or request. Determines input to the authorier function, called with the auth token or the entire request event. Defaults to token
definitions:
  Empty:
    type: "object"
    title: "Empty Schema"

Contributing

PR's are welcome! :)