@cley_faye/swagger-jsdoc-cli

1.0.1 • Public • Published

swagger-jsdoc-cli

Provide a CLI interface to generate swagger/openapi specification from swagger-jsdoc

This reproduce the minimal amount of options I required for existing project already using swagger-jsdoc. Specifically, reading the config from a JavaScript file and specifying path to source files containing OpenAPI definitions.

Usage

Install using npm (or similar):

npm install -D @cley_faye/swagger-jsdoc-cli

And run:

npx swagger-jsdoc-cli -d <config js path> -o <output path>

Configuration file

The configuration file is expected to be a JavaScript file that exports the "options" object described as the parameter to swaggerJsdoc().

Readme

Keywords

none

Package Sidebar

Install

npm i @cley_faye/swagger-jsdoc-cli

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

12.4 kB

Total Files

12

Last publish

Collaborators

  • cley_faye