shangsky/flask-sugar

Flask Sugar is a web framework for building APIs with Flask, Pydantic and Python 3.6+ type hints. check parameters and generate API documents automatically. Flask Sugar是一个基于flask,pydantic,类型注解的API框架, 可以检查参数并自动生成API文档

flask-sugar's Issues

How to return a response like List[Model]?

can you support operation mode config for the routes?

I found all routes have operation in the swagger and redoc api docs.
can you support operation mode config for the routes.

1. 'default': includes all routes in this instance.

2. 'strict': only includes routes which I wanted.

Using BaseModel in the GET parameters, is it possible?

I want GET query parameters have some validation. can you support it?

example code:

`
import datetime
from typing import List

from pydantic import Field, BaseModel
from flask_sugar import Query

class SettingQuery(BaseModel):
page: Optional[int] = Field(..., ge=1, description='page number')
limit: Optional[int] = Field(..., ge=1, le=25, description='limit number')
query: str = None

@apis_bp.get("/settings")
def settings(query: SettingQuery = Query(...)):
return {"query": query.dict()}
`

[Bug Report] Duplicate swagger/redoc api docs when I use flask_sugar's Blueprint

code:

from flask_sugar import Blueprint
auth_bp = Blueprint('auth', __name__, url_prefix='/auth')

@auth_bp.post('/obtain/token', tags=['Auth'])
def obtain_token(payload: ObtainToken):
    ...

最近接口文档好像打不开了

最近接口文档好像打不开了，有没有这种情况？

[Bug Report]When I use extension flask-debugtoolbar , error happended.

AssertionError: View function mapping is overwriting an existing endpoint function: debugtoolbar.sql_select

Traceback (most recent call last)
File "/Users/shijl0925/Pycharm/flask-example/backend/app/main.py", line 170, in
app = create_app()
File "/Users/shijl0925/Pycharm/flask-example/backend/app/main.py", line 144, in create_app
register_extensions(app_)
File "/Users/shijl0925/Pycharm/flask-example/backend/app/main.py", line 88, in register_extensions
extension.init_app(app)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask_debugtoolbar/init.py", line 84, in init_app
app.register_blueprint(module, url_prefix='/_debug_toolbar/views')
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/scaffold.py", line 57, in wrapper_func
return f(self, *args, **kwargs)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/app.py", line 1028, in register_blueprint
blueprint.register(self, options)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/blueprints.py", line 370, in register
deferred(state)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/blueprints.py", line 426, in
**options,
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/blueprints.py", line 108, in add_url_rule
**options,
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask_sugar/app.py", line 143, in add_url_rule
super().add_url_rule(rule, endpoint, view, provide_automatic_options, **options)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/scaffold.py", line 57, in wrapper_func
return f(self, *args, **kwargs)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/app.py", line 1091, in add_url_rule
"View function mapping is overwriting an existing"
AssertionError: View function mapping is overwriting an existing endpoint function: debugtoolbar.sql_select

Is it possible to support the interface of swagger's additional parameters？

Is it possible to support the interface of swagger's additional parameters like persistAuthorization？

[Bug Report]When I use extension flask-admin , error happended.

flask 2.0.2
flask-admin 1.6.0
flask-sugar 0.0.14

127.0.0.1 - - [08/Feb/2022 10:46:51] "GET /apis/openapi.json HTTP/1.1" 500 -
Traceback (most recent call last):
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/app.py", line 2091, in call
return self.wsgi_app(environ, start_response)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/app.py", line 2076, in wsgi_app
response = self.handle_exception(e)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/app.py", line 2073, in wsgi_app
response = self.full_dispatch_request()
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/app.py", line 1518, in full_dispatch_request
rv = self.handle_user_exception(e)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/app.py", line 1516, in full_dispatch_request
rv = self.dispatch_request()
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask/app.py", line 1502, in dispatch_request
return self.ensure_sync(self.view_functions[rule.endpoint])(**req.view_args)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask_sugar/view.py", line 312, in call
response = self.view_func(**cleaned_data)
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask_sugar/openapi.py", line 77, in openapi_json_view
paths, components = collect_paths_components()
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask_sugar/openapi.py", line 198, in collect_paths_components
flat_models, model_name_map=model_name_map, ref_prefix=REF_PREFIX
File "/Users/shijl0925/Pycharm/flask-example/backend/venv/lib/python3.7/site-packages/flask_sugar/openapi.py", line 185, in schema
model_name = model_name_map[model]
KeyError: <class 'pydantic.main.flask_admin__model__base__export__ParamModel'>

这么好的库继续更新啊

这个库非常好用，期待作者继续更新，加大宣传力度！

怎么获取flask的app

app = Sugar(name)，默认的app是sugar的app，请问怎么获取flask的app，这样flask中的很多第三方库啥的还能继续使用，谢谢