Easy Docs for flask
Project description
Flask-Docs-Api
A library to make doc generation painless
Installation
pip install Flask-Docs-Api
Sample Usage (copy & paste)
from flask_api_docs.api import Api
api = Api(app, "Test")
api.route("/docs")
Sample
How it works
Flask-Docs-Api uses the docstrings of your existing python code and the methods defined in your routes to generate the api docs.
Api of Flask-Docs-Api
Api class
Constructor: Requires the app, and an optional name for the api docs title.
route: takes a url for the api doc route
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
File details
Details for the file Flask-Docs-Api-1.1.1.2.tar.gz.
File metadata
- Download URL: Flask-Docs-Api-1.1.1.2.tar.gz
- Upload date:
- Size: 2.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e40b2f37c99177ab5b418e28a6d7455f1b5b7834e23ce8d972e052678b1d40de |
|
| MD5 | 3ed40b19bf1b8208dc870d57933ec5e7 |
|
| BLAKE2b-256 | 69efafa2756dcec5678cc105376e7a71ac2cbca732c44962be61d5a3f443a87c |
File details
Details for the file Flask_Docs_Api-1.1.1.2-py3-none-any.whl.
File metadata
- Download URL: Flask_Docs_Api-1.1.1.2-py3-none-any.whl
- Upload date:
- Size: 3.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a4b9df8b664a35ea478092a203ca00b9d4110562e536799f2c6f04b8065c728b |
|
| MD5 | cf829e85779ab05e3211a1a5b40843e6 |
|
| BLAKE2b-256 | 4365e619eab5889abdf4974e528e059f202ffe7d87446efbda033cfdeb9b19bb |
