Skip to content

CLI tool that allows to transform swagger definition file to markdown

Notifications You must be signed in to change notification settings

katsanva/swagger2markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

swagger2markdown

Build Status Maintainability Test Coverage

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]

About

CLI tool that allows to transform swagger definition file to markdown

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published