使用Flask和Swagger公开API文档

Question

我已经使用flask构建了一个小服务，并且已经编写了一个swagger yaml文件来描述它的API。如何通过烧瓶应用程序公开swagger文件？

我并不是要公开文件本身（send_from_directory），而是创建一个新的端点，将其显示为swagger-ui（交互式，如果可能的话）

Answer 1

好的，这就是我做的。

我使用flasgger并使用flasgger.Swagger包装我的应用。比我添加了2个端点：

1. /_api提供YAML文件（使用send_from_directory）
2. /api重定向到flasgger api /apidocs/index.html?url=/api我确信它可以做得更好，但我 找不到它。

github：https://github.com/eplaut/python-butler/blob/master/butler/butler.py#L119

Answer 2

你可以使用Flasgger，这是一个Flask扩展，它包含了Flask的Swagger UI http://github.com/rochacbruno/flasgger

Answer 3

有以下三种方法：

• 通过 Restful-Api (Api.doc)
• 通过获取 swagger 模板
• 通过注册蓝图（来自flask-swagger-ui 或smth）。