【问题标题】:Generating Swagger Docs in Firebase Cloud Functions project在 Firebase Cloud Functions 项目中生成 Swagger 文档
【发布时间】:2018-09-09 10:39:24
【问题描述】:

是否可以从 firebase 云函数中的函数 cmets 生成 Swagger Spec 文件?如果是这样,我们该怎么做?

我看到云功能代码更像无服务器,所以想知道这是否可能。

【问题讨论】:

  • 每个人都在投票,但没有答案:(
  • 嘿,我最近尝试过这样做。它具有挑战性但可能。虽然我做了很多工作让它成为可能,但在生产中的 UI 方面仍然存在问题。
  • 我最终以相反的方式结束,从长远来看,它似乎更有帮助。我创建了规范并将其用于生成代码,这有助于在需要新功能时创建大量样板代码。此外,代码更加一致,我只需要编写服务(单独的业务逻辑部分)。休息(控制器、路由、存储库等)一切都由代码生成器自动处理!

标签: firebase swagger google-cloud-functions google-cloud-firestore


【解决方案1】:

目前没有自动执行此操作的方法。我认为您可以构建自己的,但似乎需要做很多工作。

【讨论】:

    【解决方案2】:

    我还没有找到自动的方法,但是有很多库可供选择。

    我在我的 Firebase 函数实现中使用 express 和 nodejs,对我来说, Swagger 文档生成可以通过以下库实现: https://github.com/scottie1984/swagger-ui-express https://github.com/Surnet/swagger-jsdoc

    您可以在以下位置找到其他库: https://swagger.io/tools/open-source/open-source-integrations/

    这将创建一个新的 HTTP 端点,它将提供一个 swagger 文档的 HTML 页面。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2018-11-21
      • 2020-07-08
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2021-06-02
      相关资源
      最近更新 更多