Skip to main content
 首页 » 编程设计

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

2024年12月31日30zfyouxi

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

但是我实际上并没有在任何地方看到 yaml 或 json 文件。如何更改屏幕截图中显示的标题和默认值?希望不需要制作一个完整的单独的 yaml 或 json 文档就可以吗?

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

请您参考如下方法:

您在创建 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需要时寻求帮助。