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-ui

v1.1.1

Published

A serverless plugin to build Swagger UI static site

Downloads

49

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

kobanyankobanyan

Keywords

serverlessswaggerawsdocumentation

Readme

serverless-plugin-swagger-ui

serverless npm node serverless code style license semantic-release

A serverless plugin to build Swagger UI static site

Installation

npm install --save-dev serverless-plugin-swagger-ui
# or
yarn add --dev serverless-plugin-swagger-ui

Configuration

plugins:
  - serverless-plugin-swagger-ui

custom:
  swaggerUi:
    # [Optional] The name of S3 bucket to serve Swagger UI static site. If you set the S3 bucket name, this plugin will upload documentation files to the S3 bucket.
    s3Bucket: 'default is undefined'
    #  [Optional] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
    exportType: oas30 # default value
    # [Optional] The content-type of the export. Currently application/json and application/yaml are supported for exportType of oas30 and swagger.
    accepts: application/yaml # default value
    # [Optional] For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool.
    extensions: integrations # default value
    # [Optional] The name of local directory to build Swagger UI static site
    swaggerUiDirectoryName: .swagger-ui # default value
    # [Optional] Swagger UI configuration. See https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/ . 'configUrl' and 'url' will be ignored.
    swaggerUiConfig: # default value is the below
      dom_id: '#swagger-ui'
      deepLinking: true
      presets:
        - SwaggerUIBundle.presets.apis
        - SwaggerUIStandalonePreset
      plugins:
        - SwaggerUIBundle.plugins.DownloadUrl
      layout:
        - StandaloneLayout

See example.

Usage

To build Swagger UI static site after deploy:

serverless deploy

To build Swagger UI static site:

serverless swaggerUi

License

MIT © kobanyan