README.md

Swagger JSDoc Webpack Plugin

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

• swagger-jsdoc
• @types/swagger-jsdoc