2015-12-09 19 views
4

我已經通過swagger editor手動創建了YAML文件(和JSON文件)。Swagger UI/Editor like page - 添加到我的網站

現在我想將自動生成的超酷網頁從swagger-editor工具嵌入到我的網站中,以便用戶可以通過我的API進行閱讀和測試(通過「嘗試此操作」按鈕)。

我不想讓大家爲我生成任何代碼,我也不需要它自動更新文檔(YAML或其他)。我會在需要時手動更新我的靜態YAML/JSON文件。 Swagger支持這種功能嗎?這是否與在Swagger編輯器工具欄中的「生成客戶端」有關? 我正在尋找一些html/js/css文件,這些文件可能會加載靜態YAML文件並生成類似於swagger-editor的正確頁面的東西。 順便說一句,我使用Apache Web服務器(不是那麼重要)。

謝謝!

編輯:我正在尋找客戶端 - 一些js/css/html可以添加上述要求,我不介意再次生成它(每當我將改變我的YAML文件/我的REST API)

回答

5

那麼, 我找到了我正在尋找的工具,它是swagger-ui。 這看起來並不像swagger-editor右側的UI,但它滿足了我的要求 - 它僅在靜態文件中解析我的JSON文件(我手動編寫爲YAML)在客戶端在線,無需服務器端工作,只提供頁面)。

無論如何,謝謝!

編輯:我發現越來越多的人有興趣在以下link

EDIT2編輯View解決方案: 我已經添加一個簡短骯髒的解決方法預覽僅招搖編輯器的相關部分。您可以看到更改here。 ,您可以嘗試:

  1. 克隆my forked回購:git clone http://github.com/itayB/swagger-editor.git
  2. cd swagger-editor
  3. npm install
  4. npm start

請注意:此預覽顯示文件規範,文件輸出/ default.yaml。 我只做了一些視圖更改,所有編輯器邏輯仍在後面運行。

乾杯

+1

謝謝確認這個。我試圖做同樣的事情,並認爲swagger-ui是我正在尋找的工具。 – andymal

+0

@andymal是的,只要按照他們在github上的指示..(只需要第一步) - 克隆項目,使用'dist'目錄並複製你的json文件。您可能需要編輯索引。html文件與json文件的路徑,如果你把它放在不同的地方.. – ItayB

+0

在20分鐘內啓動並運行。多麼酷的項目!我所要做的只是將index.html指向我生成的json文件,並且它已啓動並正在運行。太好了! – andymal