Skip to content
Generate API docs from Swagger file into markdown file.
Branch: master
Clone or download
Latest commit 1b69828 Sep 28, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.gitignore
LICENSE
README.md
index.js
package-lock.json
package.json 1.0.4 Sep 28, 2018

README.md

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 -->
You can’t perform that action at this time.