2015-09-14 34 views
-1

我有一個用Node和Express 4編寫的服務器。我也有一個客戶,希望將它與Swagger一起記錄下來。如何才能做到這一點?爲Express 4.x創建API的Swagger文檔

我已經研究過以下工具:

  • swagger-node-express:讓你做的正是我想要的,但它不支持快速4.x的
  • Swagger 2.0 - Node-Express-4.x:同上,但用不同的做法。可以使用,除了我不要設置它發現很多文檔(我太慢得到它沒有文檔),如果我從頭開始

工具像swaggerize-expressSwaggers own tool for Node會的工作,但我只是想方便地將文檔添加到我的項目中,以便Swagger可以讀取它。

從長遠來看,寫一個Swagger可以讀取的doc文件是不行的,因爲那樣我就不得不更新它了。我想在代碼中記錄所有內容,而不是Swagger或自述文件,並讓文檔通過Swagger-UI自動提供。

我可能在這裏忽略了一些東西,但我似乎無法找到任何可以幫助我的東西。歡迎您提出任何建議。提前致謝。

回答

1

我強烈建議查看Loopback框架。它是在立體圖上創建REST API的框架。它正在使用Express,並由StrongLoop公司創建,該公司現在也自行維護Express project

它支持開箱即用的Swagger。

+0

感謝您的提示,但這意味着從頭開始,這與Swagger-CLI需要的一樣。我想在已經存在的項目中實現自我文檔。 – Esso

+0

嗯,我想看看回環代碼會給你很好的提示。因爲他們正在集成Swagger並使用Express。至少它會給你提示使用哪個庫。 – luboskrnac