https://github.com/rmariuzzo/markdown-swagger

Generate API docs from Swagger file into markdown file.
https://github.com/rmariuzzo/markdown-swagger

markdown swagger-api

Last synced: about 2 months ago
JSON representation

Generate API docs from Swagger file into markdown file.

• Host: GitHub
• URL: https://github.com/rmariuzzo/markdown-swagger
• Owner: rmariuzzo
• License: mit
• Created: 2017-07-17T23:20:51.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-28T20:18:01.000Z (almost 6 years ago)
• Last Synced: 2024-04-15T00:27:21.085Z (5 months ago)
• Topics: markdown, swagger-api
• Language: JavaScript
• Homepage:
• Size: 241 KB
• Stars: 72
• Watchers: 3
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
Markdown Swagger

  
Generate API docs from Swagger file into markdown file.



![Mardown Swagger Example](.github/banner.png)

## Installation

```shell

npm install markdown-swagger

```

### Usage

```shell

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

  Everything here will be replaced by markdown-swagger

```