Flask-RESTX合并api.model与reqparse参数到@api.expect实现Swagger全文档化
解决方案
直接将api.model对象和parser对象放在列表中传入单个@api.expect()装饰器即可,Flask-RESTX会自动识别不同位置的参数,在Swagger页面分别展示。叠写多个@api.expect()的写法只会让最后一个装饰器的参数生效,无法同时展示所有参数。
正确实现代码示例
filters = api.model('filters', { 'x': fields.Raw(description='x参数说明') }) parser = reqparse.RequestParser() parser.add_argument('b', type=int, location='args', help='查询参数b的说明') class Process(Resource): # 把两类参数放在列表中传入,可同时开启全局参数校验 @api.expect([filters, parser], validate=True) def get(self): # 原有参数获取逻辑不变 query_args = parser.parse_args() json_payload = api.payload # 剩余业务逻辑
复用优化方案
针对你有大量端点使用相同filter规范的场景,可以直接把组合参数封装为公共变量全局复用:
# 全局定义公共参数组合 common_filter_params = [filters, parser] # 其他需要相同参数的端点直接引用即可 class AnotherProcess(Resource): @api.expect(common_filter_params) def get(self): # 业务逻辑
内容的提问来源于stack exchange,提问作者isebarn
相关产品推荐
相关产品推荐

