在swagger页面中显示flask_restplus API的路由级别或操作级别文档

时间:2019-10-29 10:23:27

标签: swagger flask-restplus

我想在我的flask_restplus API的Swagger文档页面上显示一些有关我的API实际作用的描述。问题在于参数级别描述显示在页面上,而路由级别或操作(GET / POST / PUT / DELETE)描述却不显示。

我尝试在类(路由级别)或方法(操作级别)上使用@ ns.doc装饰器,我尝试了如下调用:

@ns.doc('some description', params={common params dict})
@ns.route('/route')
class RouteClass(Resource)
    @ns.doc('operation description', params={operation params dict}, responses={responses documentation})
    def get(self):
        #parse args and call controller

我也尝试过关键字参数@ ns.doc(id ='some description'...),但没有成功。除了api的Swagger页面中的参数或响应以外,我看不到其他任何级别的描述。

flask_restplus页面上的api.doc文档非常简短,没有说明如何实现。插件的0.13.0版本有可能吗?

0 个答案:

没有答案