flask-restplus marshal_with()与doc()装饰器位置问题

最新推荐文章于 2025-01-07 11:19:05 发布

原创最新推荐文章于 2025-01-07 11:19:05 发布 · 3.1k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#flask_restplus #flask #restful

python flask 专栏收录该内容

15 篇文章

订阅专栏

本文解决了一个在使用Flask-RESTPlus框架时，Swagger页面无法正确显示model的问题。关键在于确保marshal_with()或expect()紧跟在doc()装饰器之后，以确保参数和返回类型能被正确解析并展示。

yourapp.marshal_with(model)必须跟紧youapp.doc()才会在swagger页面上展示model

先看这段代码：

@api.doc('GetList')
@api.param('changenumber', '变更单号')
@api.param('mindate', '起始日期')
@api.param('maxdate', '截至日期')
@api.response(ARGUMENTS_ERROR, 'need at least one argument')
@api.response(HTTP_NOT_FOUND, 'no record found')
@api.response(HTTP_GET_SUCCESS, 'query success')
@api.marshal_with(list_model)
def get(self):
	pass

有没有发现什么异常？
咋一看，该有的都有，很全面呀，可是在swagger页面上：
swagger展示页面

嗯？marshal_with定义的model呢？被天狗吃掉啦？？？

后来对比了下官方DEMO，发现doc和marshal_with()或者expect()要放到一起写才行：

@api.doc('Get_Plan_List')
@api.marshal_with(record_list_model)
@api.param('changenumber', '变更单号')
@api.param('mindate', '起始日期')
@api.param('maxdate', '截至日期')
@api.response(ARGUMENTS_ERROR, 'need at least one argument')
@api.response(HTTP_NOT_FOUND, 'no record found')
@api.response(HTTP_GET_SUCCESS, 'query success')
def get(self):
	pass