flask自动注入并校验参数自动生成文档的API扩展flask-sugar
文章目录
介绍
我最近仿照fastapi写了一个flask的api扩展flask-sugar,flask-sugar可以自动注入并校验请求头,cookie,查询参数,路径参数,请求体json,form表单,文件, 响应数据,并生成对应的swagger文档。
文档: https://shangsky.github.io/fl...
源码: https://github.com/shangsky/f...
安装
pip install flask-sugar例子
# 保存为app.py
from flask_sugar import Sugar, Header
from pydantic import BaseModel
app = Sugar(__name__)
class Item(BaseModel):
name: str
size: int
class Resp(BaseModel):
a: int
b: str
c: str
item: Item
@app.post("/item/<a>")
def demo(
a: int, # 路径参数
item: Item, # 请求体json参数
b: str = "default_query_param_b", # 查询参数
c: str = Header("default_header_param_b"), # 请求头参数
) -> Resp:
"""demo page"""
return Resp(a=a, b=b, c=c, item=item)运行
flask run --reload
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)文档
现在访问swagger文档地址 http://localhost:5000/doc:

访问Redoc文档地址 http://localhost:5000/redoc:

希望各位大佬们给俺点个star
评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论