Skip to content

Generate API docs from Swagger file into markdown file.

License

Notifications You must be signed in to change notification settings

rmariuzzo/markdown-swagger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 -->

About

Generate API docs from Swagger file into markdown file.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published