markdown-swagger

Generate markdown API docs (swagger).

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
markdown-swagger
1.0.44 years ago5 years agoMinified + gzip package size for markdown-swagger in KB

Readme

Markdown Swagger

Generate API docs from Swagger file into markdown file.


Mardown Swagger Example

Installation

npm install markdown-swagger

Usage

markdown-swagger ./api/swagger/swagger.yaml ./README.md

This will read the specified swagger file and generate a table describing the API inside the target markdown file.
The markdown-swagger script will look for the for the following piece of text inside the target markdown file to do its stuff:
<!-- markdown-swagger -->
  Everything here will be replaced by markdown-swagger
<!-- /markdown-swagger -->