swagger2markdown

CLI tool that allows to transform swagger definition file to markdown.

The main difference from other available tools - it renders menu and detailed examples.

Installation

npm i -g swagger2markdown

Usage

Usage: swagger2markdown -swagger [string] -markdown [string] -p [boolean]
 
Options:
  --swagger, -s        Path to swagger file                           [required]
  --markdown, -m       Path to output markdown file                   [required]
  --prependHeader, -p  Should produce raw markdown or add render-related header                                                  [boolean] [default: true]