为用 Express 4.x 编写的 API 创建 Swagger 文档

Question

我有一个用 Node 和 Express 4 编写的服务器。我也有一个客户希望用 Swagger 记录这一点。 如何才能做到这一点？

我研究了以下工具：

• swagger-node-express ：让你做我想做的，除了它不支持 Express 4.x
• Swagger 2.0 - Node-Express-4.x ：与上面相同，但采用不同的方法。 可以使用，除了我没有找到太多关于设置它的文档（而且我在没有文档的情况下获取它太慢了）

如果我从头开始，像swaggerize -express和Swaggers 自己的 Node工具这样的工具会起作用，但我只是想要一种方法来轻松地将文档添加到我的项目中，以便 Swagger 可以阅读它。

从长远来看，编写 Swagger 可以读取的文档文件是行不通的，因为那样我就必须更新它。 我想记录代码中的所有内容，而不是 Swagger 或自述文件，并让文档自动通过 Swagger-UI 可用。

我可能在这里忽略了一些东西，但我似乎找不到任何可以帮助我的东西。欢迎所有建议。 提前致谢。

Answer 1

我强烈建议研究Loopback框架。 它是在stereoids 上创建REST API 的框架。 它在幕后使用 Express，由 StrongLoop 公司创建，该公司现在也维护Express 项目本身。

它支持开箱即用的 Swagger。