A Python module to generate a page documenting the API of a Flask application.
Project description
Flask API Auto-documentation
A Python module to generate a page documenting the API of a Flask application.
Installation
pip install flask-audo-doc
Usage
import flask
from flask_api_autodoc.view import render_page
app = flask.Flask('demo')
app.route('/info')(render_something)
app.route('/api/this')(render_something)
app.route('/api/that')(render_something)
@app.route('/doc')
def _():
return render_page(path_prefixes=['/api'])
Support
Please open an issue for support.
Contributing
Clone, edit, and submit pull requests.
Dev Automation
make clean
make test
make tox
make install-local
make build
Author
Lawrence Siden
Westside Consulting LLC
Ann Arbor, MI USA
lsiden@gmail.com
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for flask_api_autodoc-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 938d81dbcc54aa252f3a36c6dcad60ebc80b9212b263bf6d801865a162981ccc |
|
MD5 | dfc9bc06e48703680ca68380d9832b41 |
|
BLAKE2b-256 | 05b4b80c0247a72a99baeb0d8cbddf63d5643e0ef135a112f84a97e66af82908 |