使用 Flask 和 Swagger 公开 API 文档

Question

我已经使用

flask

构建了一个小型服务，并且已经编写了一个 swagger 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/ad55292eb7c2b76c6554fa8becab9d0c1c7b5862/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）。