Flask toolkits to boost your development and simplify flask, its featured with AutoSwagger
Project description
Flask Toolkits
Repository
Installation
pip install flask-toolkits
Description
Flask toolkits implements and provides several features from FastAPI
like:
- automatic API documentation using
AutoSwagger
(define the function and we'll generate the openapi spec for you) - Base HTTP Middleware (middleware with direct access to
request
andresponse
) - pydantic's validator
- Response functions that could return any type of data without worried to get error
- much more..
Changelogs
- v0.0
- First Upload
AUTO SWAGGER DOCUMENTATION
define your router using APIRouter
class, lets put it in another pyfile
email_view.py
from typing import Optional
from flask_toolkits import APIRouter, Body, Header, Query
from flask_toolkits.responses import JSONResponse
router = APIRouter("email", import_name=__name__, static_folder="/routers/email", url_prefix="/email")
@router.post("/read", tags=["Email Router])
def get_email(
id: int = Body(...),
name: Optional[str] = Body(...),
token: int = Header(...),
race: Optional[str] = Query(None)
):
return JSONResponse({"id":id, "name": name})
main.py
from flask import Flask
from flask_toolkits import AutoSwagger
from email_view import router as email_router
app = Flask(__name__)
auto_swagger = AutoSwagger()
app.register_blueprint(email_router)
app.register_blueprint(auto_swagger)
if __name__ == "__main__":
app.run()
then you can go to http://localhost:5000/docs
and you will found you router is already documented
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
flask-toolkits-0.0.8.tar.gz
(89.3 kB
view details)
Built Distribution
File details
Details for the file flask-toolkits-0.0.8.tar.gz
.
File metadata
- Download URL: flask-toolkits-0.0.8.tar.gz
- Upload date:
- Size: 89.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f2f5b98e840b0232f6910f7a26dd1d4439c482d36af8dd5f24dc604d9b03f8c |
|
MD5 | 7816070a8bda3703e5fc19cf795e92c1 |
|
BLAKE2b-256 | 6641f7a49228a14e631d925942a356def3703bff5e08a350e23947addcf1bb03 |
File details
Details for the file flask_toolkits-0.0.8-py3-none-any.whl
.
File metadata
- Download URL: flask_toolkits-0.0.8-py3-none-any.whl
- Upload date:
- Size: 18.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fd56fe3534081d6a8de47e3e47c2d3018b55196ea1038b562c7cf59432a9865 |
|
MD5 | af3e7f181f535792ac81524cab9c4231 |
|
BLAKE2b-256 | 88d9314c873307cff9d9696eea146b04c2efa8e6d677e4c78f6509deb555c11b |