No Proscribed Meaning

    markdown-swagger

    1.0.4 • Public • Published

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

    Keywords

    none

    Install

    npm i markdown-swagger

    DownloadsWeekly Downloads

    254

    Version

    1.0.4

    License

    MIT

    Unpacked Size

    5.06 kB

    Total Files

    4

    Last publish

    Collaborators

    • rmariuzzo