【问题标题】:Exposing API Documentation Using Flask and Swagger使用 Flask 和 Swagger 公开 API 文档
【发布时间】:2016-09-05 00:12:57
【问题描述】:

我已经使用flask 构建了一个小型服务,并且已经编写了一个招摇的 yaml 文件来描述它的 API。如何通过flask应用暴露swagger文件?

我并不是要公开文件本身 (send_from_directory),而是要创建新的端点,将其显示为 swagger-ui(如果可能,交互式)

【问题讨论】:

    标签: python flask swagger


    【解决方案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

    【讨论】:

      【解决方案2】:

      您可以使用 Flasgger,这是一个为 Flask http://github.com/rochacbruno/flasgger 包装 Swagger UI 的 Flask 扩展程序

      【讨论】:

        【解决方案3】:

        有以下三种方法:

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

        【讨论】:

          猜你喜欢
          • 1970-01-01
          • 2021-11-05
          • 2014-06-17
          • 1970-01-01
          • 1970-01-01
          • 2014-02-22
          • 1970-01-01
          • 2014-06-05
          • 1970-01-01
          相关资源
          最近更新 更多