https://github.com/lsiden/flask-api-autodoc
https://github.com/lsiden/flask-api-autodoc
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lsiden/flask-api-autodoc
- Owner: lsiden
- Created: 2021-04-06T19:31:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-15T17:35:56.000Z (over 3 years ago)
- Last Synced: 2025-02-26T11:47:52.268Z (about 2 months ago)
- Language: Python
- Size: 31.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - lsiden/flask-api-autodoc - (Python)
README
# 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](https://github.com/lsiden/flask-api-autodoc/issues/new) 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
[email protected]
## License
MIT