使用 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）。