🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Sign inDemoInstall
Socket

swagger-jsdoc-webpack-plugin

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

swagger-jsdoc-webpack-plugin

A webpack plugin to generate a swagger.json file from jsdoc

2.1.0
latest
Source
npm
Version published
Weekly downloads
561
-52.26%
Maintainers
1
Weekly downloads
 
Created
Source

Swagger JSDoc Webpack Plugin

npm Version npm Downloads Known Vulnerabilities License

Example Usage

webpack.json

const SwaggerJSDocWebpackPlugin = require('swagger-jsdoc-webpack-plugin');

module.exports = {
  ...
  plugins: [
    new SwaggerJSDocWebpackPlugin({
      definition: {
        openapi: '3.0.0',
        info: {
          title: 'Title',
          version: '1.0.0',
          description: 'Description',
        },
      },
      apis: ['./src/routes/**/*.js'],
    }),
    ...
  ],
  ...
}

This writes a swagger.json file in your output folder.

Options

outputFile?: string

The path of the generated swagger file. Default: "swagger.json"

swagger-jsdoc options

All other options are directly passed to swagger-jsdoc.

Dependencies

Keywords

swagger

FAQs

Package last updated on 17 Dec 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts