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.11.tar.gz
(994.2 kB
view hashes)
Built Distribution
Close
Hashes for flask_toolkits-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd5f94c2d440b60ac8726c5f4be2981067c30cdafd690861314a878309a57f82 |
|
MD5 | fec1c2286e06b1017907960072f44883 |
|
BLAKE2b-256 | b4e863831f3e99c70faa4f116ffa4604bd13f6a7ebcdb68b8149fb2663008a01 |