flask_restplus:如何设置动态swagger文档?

时间:2018-09-07 00:42:32

标签: swagger real-time documentation-generation flask-restplus

我正在使用flask_restplus版本0.10.1进行项目。我们无法选择使用其他版本。

我们将其用于REST风格的接口,该接口的路由通过配置文件控制。我们使用以下结构来做到这一点:

@app.route('/<path:path>')
class OurResource(Resource)
    def get(self, path):
        # ... etc. ...

get方法调用一个例程,该例程在我们从配置文件加载的数据中查找path,然后使用该数据来决定如何响应请求。这样一来,我们就可以通过配置更改应用程序的行为,而无需重建flask_restplus应用程序,甚至无需重新启动Web服务器。

由于flask_restplus自动文档模块没有可用的硬编码路由,因此我需要根据配置文件中的信息生成必要的内部swagger文档结构。我还没有弄清楚该怎么做。

此草率文档通常是通过flask_restplus.Api类中的方法调用生成的,但是当我尝试对其进行子类化时,会出错。此类显然不是要子类化的,这意味着我不能只重写一些方法,而是让子类根据我们的配置文件数据生成文档。

flask_restplus中是否有任何方法可以根据外部信息(例如配置文件中的信息)在运行时动态生成swagger文档结构?

预先感谢您的任何建议。

0 个答案:

没有答案