/mkdocs-swagger-plugin

MkDocs plugin for render swagger into docs

Primary LanguageJavaScriptMIT LicenseMIT

mkdocs-swagger-plugin

Open Source Saturday

MkDocs plugin for render swagger into docs

Installation

pip install git+https://github.com/allevo/mkdocs-swagger-plugin#egg=SwaggerPlugin

Add the plugin into mkdocs.yml

plugins:
    - swagger
extra:
    swagger_url: 'https://petstore.swagger.io/v2/swagger.json'

Usage

For time being this plugin use double exclamation points to introduce a box for invoking an API.

!!GET /pet/{petId}!!

License

MIT License