node-swagger-to-md
Transform swagger to markdown. Output is sorted alphabetically.
Usage
Usage: swagger-to-md <swagger> Options: -h, --help Output usage information -v, --version Output version number -y, --yaml Use swagger YAML instead of JSON Examples: $ swagger-to-md spec.json # Transform swagger to markdown $ swagger-to-md < spec.json # Transform swagger to markdown $ swagger-to-md -y spec.yaml # Transform swagger yaml to markdown Docs: https://github.com/TabDigital/node-swagger-to-mdBugs: https://github.com/TabDigital/node-swagger-to-md/issues
Example output
path | method | summary |
/foo/bar | GET | get all bars in the area |
/bin/baz | PUT | add a new baz to the region |
Installation
$ npm install swagger-to-md