Swagger Core Java 程式庫首次支援 OAS 3.0

  2017 年 8 月 24 日

Swagger 團隊很自豪地宣布 swagger-core 和 swagger-parser 的第一個候選版本,新增對 OpenAPI 規範 3.0.0 (OAS 3.0) 的支援!

隨著新版規範的發布,我們確信使用者都迫不及待想試用。先前,我們已發布Swagger UI 和 Swagger 編輯器中對 OAS 3.0 的支援,現在輪到 Java 世界邁出這一步。

新程式庫的發布適用於早期採用者,並且有一些已知的限制,如下所述。透過此第一個版本,我們希望您協助回報問題,甚至提交 PR 來修正。請注意,由於是候選版本,API 可能會變更,直到最終發布,為您的應用程式帶來重大變更。

以下是 Swagger-core 和 Swagger-parser 中的新增功能

Swagger-core 是一組模組,可與 JAX-RS 和 Servlets 等一些 Java 技術整合,以產生 OpenAPI 定義。然而,swagger-core 不僅僅如此,它還提供一組模型來表示 OpenAPI 標準中的 API 定義,以及一組可用於使用其他資訊裝飾程式碼的註釋。Swagger 工具集下的其他專案和社群工具都會使用這兩個模組。

新版本的 swagger-core 代表程式碼的重大重寫,目前編號為 2.0.0-rc1。此版本提供一些關鍵功能和變更

  • 僅支援 OAS3。就像之前的 swagger-core 版本一樣,僅支援一個規範版本。
  • 作為一段時間以來的第一個主要版本發行,註釋已完全重寫並調整為支援新版本的規範。
  • 這表示 swagger-core 2.X 與之前的版本有重大變更。
  • 目前的 RC 僅支援 JAX-RS2。
  • 程式碼庫使用 Java 8。

我們鼓勵您閱讀完整的發行說明並取得更多資訊。程式碼本身可以在 2.0 分支中找到,並且會保留在那裡直到官方穩定版本發布。我們也將在接下來的幾週內開始在 wiki 中提供更多有關新整合的文件。

我們的 OpenAPI 定義反序列化器 Swagger-parser 也已發布版本 2.0.0-rc0。與 swagger-core 非常相似,這可讓您支援讀取 OAS3 定義並將其剖析為模型樹。該專案還包括從 OAS2 到 OAS3 的轉換器,並會在嘗試剖析此類定義時自動使用它。與 swagger-core 一樣,程式碼本身可以在 2.0 分支中找到,並且會保留在那裡直到官方穩定版本發布。

其他 Swagger Java 專案的下一步是什麼?

很高興您問!我們目前專注於擴展 swagger-core、改進 swagger-parser 中的轉換器,並實作新版本的 swagger-inflector,並支援 OAS3。

validator-badge 和 swagger-codegen 將是下一步!

如需 Swagger 團隊發布的最新更新,您可以透過 Twitter @SwaggerAPI 追蹤我們,或在部落格側邊欄訂閱。