# [2.1.0](https://github.com/patsimm/swagger-jsdoc-webpack-plugin/compare/v2.0.2...v2.1.0) (2022-12-17)


### Features

* add outputFile option ([67a316e](https://github.com/patsimm/swagger-jsdoc-webpack-plugin/commit/67a316e05606fd550144f8eb347a0c2982fee236))





v2.1.0

# Swagger JSDoc Webpack Plugin

[![npm Version](https://img.shields.io/npm/v/swagger-jsdoc-webpack-plugin.svg)](https://www.npmjs.com/package/swagger-jsdoc-webpack-plugin)
[![npm Downloads](https://img.shields.io/npm/dm/swagger-jsdoc-webpack-plugin.svg)](https://www.npmjs.com/package/swagger-jsdoc-webpack-plugin)
[![Known Vulnerabilities](https://snyk.io/test/github/patsimm/swagger-jsdoc-webpack-plugin/badge.svg?targetFile=package.json)](https://snyk.io/test/github/patsimm/swagger-jsdoc-webpack-plugin?targetFile=package.json)
![License](https://img.shields.io/npm/l/swagger-jsdoc-webpack-plugin.svg)


## Example Usage

webpack.json
```javascript
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](https://github.com/Surnet/swagger-jsdoc).


## Dependencies
- [swagger-jsdoc](https://github.com/Surnet/swagger-jsdoc) 
- [@types/swagger-jsdoc](https://www.npmjs.com/package/@types/swagger-jsdoc)


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

swagger-jsdoc-webpack-plugin

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

swagger-jsdoc-webpack-plugin

v2.1.0

2.1.0 (2022-12-17)

Features