首页 > 解决方案 > 如何用字符串列表记录 flask-restplus 响应

问题描述

我正在记录我的响应模型,并且需要显示 api 返回字符串列表。

["user1","user2"]

但模型需要字典(json)格式,如下:

ns.response(200,'Success', NS.model("my_get_model",[{
    "name": fields.String(example="user1"),
}]))

我尝试了以下代码,但它们都不起作用:

ns = Namespace('My Apis')


ns.response(200,'Success', [ns.model("my_get_model",
    fields.String(example="user1")
)])

或者

ns.response(200,'Success', ["user1"])

或者

ns.response(200,'Success', ns.model("my_get_model",fields.List(fields.String(example="user1"))))

请指教。

标签: pythonswaggerflask-restplus

解决方案


我认为这就是你需要的:https ://github.com/python-restx/flask-restx/issues/65

尝试简单地传入fields.List而不包装模型。

ns.response(200, 'Success', fields.List(fields.String(example="user1")))

仅供参考,flask-restx它是一个分支,flask-restplus它应该具有更多更新的功能,因为由于开发人员无法联系项目所有者flask-restplus而不再维护。flask-restplus


推荐阅读