為用 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。