如何编辑Flask-plus默认的swagger-UI文本

时间:2018-11-10 08:47:16

标签: python rest flask swagger flask-restplus

我正在开发一个简单的rest api,到目前为止只有两个Get方法。它工作正常等,并且由于内置的​​swagger文档,当我导航到url时,它看起来很棒。

但是我实际上在任何地方都看不到yaml或json文件。如屏幕截图所示,如何更改标题和默认值?希望有可能无需制作整个单独的Yaml或JSON文档?

我实际上根本不想更改设计。我只想稍微编辑一下文字。

enter image description here

1 个答案:

答案 0 :(得分:1)

您在创建API时设置标题:

api = Api(app, version='1.0', title='Your API Name', 
          description='A more complete description')

通过创建名称空间,将名称空间设置为默认以外的其他名称:

ns = api.namespace('not-default', 
                   description='Whatever your namespace is')

然后您在适当的名称空间中创建路由:

@ns.route(...)

这是对API进行分组的便捷方法。如果需要,请查看Full Example以获得帮助。