使用 Flask 和 Swagger 公开 API 文档

Question

我建立一个小型服务flask和已经写了一个招摇YAML文件来描述它的API。 如何通过flask应用程序公开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 包装 Swagger UI 的 Flask 扩展http://github.com/rochacbruno/flasgger

Answer 3

有以下三种方法：

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