新的 Swagger Editor 和 Swagger UI
自上次更新以來兩年,並在聽取數萬名使用者的意見回饋後,新的 Swagger UI 和 Swagger Editor 終於問世了! 它們將速度和可靠性帶到 API 設計和文件流程的最前沿。新版本還引入了擴展機制,允許使用者完全客製化介面,並在核心 Swagger 平台之上建立自己的功能。
您可以在它們各自的 GitHub 儲存庫中找到這些專案。
Swagger-UI: https://github.com/swagger-api/swagger-ui
Swagger-Editor: https://github.com/swagger-api/swagger-editor
顯然,我們預期會有問題,因此我們在下方新增了常見問題解答部分。
常見問題解答
等一下,剛剛發生什麼事?
Swagger-UI 最初於 2011 年發布,而 Swagger-Editor 則於 2014 年發布。如同大多數人所知,這兩個專案是獨立開發的,它們基於不同的技術,並且沒有提供相同的用戶體驗。我們最終「合併」了這兩個專案,對兩者都採用相似的技術基礎。在我們的工作中,我們也完全重做了 swagger-js。
所以現在有一個專案了嗎?
嗯,不是。我們建立了一個新的可插拔系統。Swagger-UI 現在包含該系統的核心,而編輯器只是一組新增到其中的外掛程式。我們仍然提供一種方法讓您在不需要了解這些外掛程式如何運作的情況下,以專案的形式執行 swagger-editor。
為什麼要經歷這麼多麻煩?
原因有很多
- 如上所述,合併技術並轉移到較新的技術。這些專案已經過時,是時候加速了。
- 我們希望為這兩個專案提供熟悉的 UI。
- 為了給您更多自訂功能。多很多。
- 為了給您更多擴充性。您猜對了,多很多。
- 為了讓我們更容易支援規格的下一個版本。
- 為了提高渲染、驗證的效能。
- 為了改善編輯器中的驗證,讓使用者更容易從頭開始撰寫規格。
嘿,UI 怎麼了?!我比較喜歡 Swagger-X 中的樣子!
我們汲取了現有專案的優點,讓它們煥然一新,瞧!我們可能會在未來幾週內進行更多變更,而且當我們支援規格的下一個版本時,肯定會有更多變更。
但我想要舊的外觀和風格!
這就是新專案的優點所在 - 如果您想修改 UI 以符合您的需求,現在會容易得多。
它支援規格的下一個版本嗎?
如上所述,進行此變更的主要原因之一是讓我們更容易支援規格的下一個版本。那是我們待辦事項清單中的下一個主要事項。
那麼之前版本的專案中的問題呢?它們會繼續開發嗎?我們可以期待多久的支援?
考慮到規格的下一個版本,以及我們在新專案中投入的工作,我們不再積極開發之前的版本。我們的努力重點是新版本的專案。我們將繼續支援較舊的版本幾個月,以便讓大家有足夠的時間進行轉換。我們將發布正式公告,宣布正式停止支援。在某些情況下,我們仍然會提供舊專案的新版本,具體取決於問題的嚴重程度。
新專案支援哪些規格版本?
2.0,而且我們正在努力支援規格的下一個版本。不再支援較舊的版本。對於那些仍然使用舊於 2.0 版規格的人,我們鼓勵您花時間研究升級它。
它缺少功能 X!功能 Y 已損壞!
糟糕。我們已盡力做到與功能對等,但我們可能漏掉了一些。請在專案上將缺少的功能以票證形式提出,幫助我們。
我如何提供協助?
就像您之前所做的那樣
- 有什麼東西無法運作?提出票證!
- 有什麼東西遺失?提出票證!
- 您希望看到更多嗎?提出票證!
- 有時間解決上述任何問題嗎?提交 PR!
就這麼簡單。