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 cleanmake testmake toxmake install-localmake build
Author
Lawrence Siden
Westside Consulting LLC
Ann Arbor, MI USA
lsiden@gmail.com
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for flask-api-autodoc 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| flask-api-autodoc-1.0.0.tar.gz | 3.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flask_api_autodoc-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.9 kB
Release files / flask-api-autodoc-1.0.0.tar.gz
| Download URL | flask-api-autodoc-1.0.0.tar.gz |
|---|---|
| Size | 3.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
04c5c906fdc40bf022620250d0a8a44c3d28b825b44d8e486852279b8c67a807
|
|
BLAKE2b-256 checksum How to use checksums |
150a3d9a4471e4d388df5a74354b8b4528fef63af282dc0ae9adfeda09651c7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.5 CPython/3.8.9 Darwin/20.3.0
|
Release files / flask_api_autodoc-1.0.0-py3-none-any.whl
| Download URL | flask_api_autodoc-1.0.0-py3-none-any.whl |
|---|---|
| Size | 4.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
938d81dbcc54aa252f3a36c6dcad60ebc80b9212b263bf6d801865a162981ccc
|
|
BLAKE2b-256 checksum How to use checksums |
05b4b80c0247a72a99baeb0d8cbddf63d5643e0ef135a112f84a97e66af82908
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.5 CPython/3.8.9 Darwin/20.3.0
|
