markdown-oas v2.0.1

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

Installation

npm install markdown-swagger

Usage

markdown-oas ./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-oas script will look for the for the following piece of text inside the target markdown file to do its stuff:

<!-- markdown-oas -->
  Everything here will be replaced by markdown-swagger
<!-- /markdown-oas -->

Develop

Testings

node index.js openapi.yaml test.md