Firebase Cloud Firestore“请求/响应”文档

Question

我参与的大部分“更大”项目都是使用 REST API 进行前端->后端通信。我将 Firebase Cloud Firestore 用于一些小型（一日/黑客马拉松）项目。现在我正在考虑将 Firestore 用于一些更大的项目，但我不确定这是否可行。

对于“标准”REST api 项目，我有 Swagger 文档，每个开发人员都可以在其中看到具有请求/响应数据结构的所有端点的列表。它如何与 Firestore 配合使用？我可以为开发人员创建类似的文档来检查数据结构，以便他们知道可以添加什么以及应该阅读什么？或者也许还有其他方法？

我在想，因为前端数据结构正在定义数据库结构，所以可能没有此类文档的工具？但是，如果我从两个或多个平台（例如 Web、移动和云功能）连接数据库怎么办？如何在所有开发人员之间同步有关数据结构的知识？

我一直在寻找一些答案，但找不到任何有用的建议来手动维护一些文档。它在您的项目中是如何工作的？有一些自动化吗？手动编写的文档？或者没有文档——一切都“在代码中”？

Answer 1

我理解您的担忧，但遗憾的是，Cloud Firestore 没有像 Swagger 这样的工具来生成数据库结构的文档。

我相信你可以通过编程来做到这一点。

Answer 2

从 Generating Swagger Docs in Firebase Cloud Functions project

我在我的 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

除了那里的响应之外，以下服务允许您访问 Firestore 元数据，单击资源管理器选项卡，看起来很适合您的用例 https://aapi.io/api-directory/Google_CloudFirestore_GoogleCloudFirestoreAPI_v1beta1，但不一定比上面的链接更有效。