Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.1 KB

README.rst

File metadata and controls

38 lines (27 loc) · 1.1 KB

Flask ApiDoc

Flask ApiDoc is a Flask extension which adds support for the ApiDoc.

Version

Features

  • click command to generate the apidoc's files, by default they are generated into static/docs
  • Host apidoc's files, by default they are hosted in http://localhost:5000/docs
  • Replace the base URL for the endpoints by the current Flask URL.
  • Allow absolute urls in @api

Documentation

Soon... take a look at the example to see how it works.

Installation

You can install flask-apidoc via Python Package Index (PyPI),:

$ pip install flask-apidoc

Feedback

Please use the Issues for feature requests and troubleshooting usage.