正式發佈 OpenAPI 3.0

  2017 年 7 月 26 日

我們很高興宣佈下一代的 OpenAPI 規格 (OAS) 正式發佈!

OAS 3.0 是基於原始的 Swagger 2.0 規格,旨在提供一個標準格式,統一業界定義和描述 RESTful API 的方式。OAS 3.0 的發佈標誌著 API 經濟成長的一個重要里程碑,匯集了來自各行各業的合作者,以公開透明的方式發展規格,以滿足全球 API 開發者和消費者的需求。

當 Swagger 團隊於 2015 年加入 SmartBear 時,SmartBear Software 將 Swagger 2.0 規格捐贈給 OpenAPI Initiative。我們很高興看到依賴該規格來設計、記錄和開發 API 的 API 提供商,將能夠使用 OAS 3.0 進一步發展其 API 開發。

若要深入瞭解 OpenAPI 3.0 的新功能,請參加我們 9 月 26 日的免費培訓,OpenAPI 3.0:如何使用最新的 OpenAPI 規格 3.0 設計和記錄 API.

OAS 3.0 的新功能?

OAS 3.0 的開發確實是一項協作努力,不僅針對 OpenAPI 技術開發委員會的成員和 OAI 的 27 個成員,還針對成千上萬為此努力做出貢獻的開發人員和架構師,發送提取請求並提供意見回饋,這些都有助於推動規格的發展。

我們將在未來幾週內發佈許多有關 OAS 3.0 的新資源和培訓,但現在先概述一下您可以在 3.0 中看到的一些新更新和功能

  • 重新架構規格的整體結構,以提高可重複使用性
  • 新增對描述回呼的支援
  • 連結以表達操作之間的關係
  • JSON 結構描述包含以下支援:oneOf、anyOf 和 not
  • 改進參數描述,包括使用結構描述的能力
  • 更好地支援 multipart 文件處理
  • 包含 Cookie 參數;排除 dataForm 參數
  • Body 參數有自己的實體
  • 更好地支援內容類型協商
  • 簡化和增強了安全性定義

這對 Swagger 意味著什麼?

關於發佈一個具有新名稱的新規格對 Swagger 的未來意味著什麼,已經有很多疑問。作為一個開發圍繞該規格的工具已有 6 年以上時間的團隊,Swagger 專案將繼續成為一類高品質的工具,以更好地實作 OAS。

Swagger 產生的一些工具是 Swagger UISwagger Editor。Swagger UI 使 OpenAPI 規格(以前稱為 Swagger 規格)栩栩如生,讓使用者能夠以易於閱讀和理解的格式視覺化 API 並與之互動。Swagger Editor 是另一個受歡迎的開放原始碼專案,是使用 OpenAPI 規格設計 API 的事實上的開放原始碼編輯器。這些只是 Swagger 繼續開發和成長的許多工具中的一部分,讓開發人員和消費者能夠利用 OAS。

我們將繼續投資開發這些工具和其他 Swagger 專案,以充分利用 OAS 3.0 的強大功能。在接下來的幾週內,我們將分享更多關於 3.0 支援何時會應用於不同 Swagger 工具的詳細資訊,以及 3.0 對於 SwaggerHub 平台 的意義。此外,您可以期望在未來幾週、幾個月和幾年內看到團隊發佈一些令人興奮的新 Swagger 專案!

OAS 3.0 對於使用 Swagger 2.0 的 API 意味著什麼?

短期內,沒有任何影響。您可以繼續將 Swagger 2.0 與任何 Swagger 工具、SwaggerHub 或任何其他支援 2.0 規格的平台一起使用。我們將在可預見的未來繼續支援 2.0 規格的使用。

我們正在開發工具來協助轉換到 3.0 的過程,因此請密切關注接下來的發展。

深入瞭解:想要為您的 API 建立 OpenAPI 3.0 嗎?Swagger Inspector 可協助您

在哪裡可以瞭解 OAS 3.0?

在 Swagger,我們非常關心 OpenAPI 規格,因此我們不斷為人們建立資源,以瞭解更多相關資訊。以下是我們最喜歡的 OAS 3.0 資源列表

我們鼓勵您也瀏覽 GitHub 上的 OAI 3.0 文件,以瞭解 OAS 3.0 的新功能。

在此處閱讀來自 OpenAPI Initiative 的完整公告。

開始使用 OpenAPI 3.0

您可以使用 SwaggerHub 中的 OpenAPI 3.0 開始設計和記錄新的和現有的 API。SwaggerHub 編輯器可讓您使用 OpenAPI 3.0 定義和視覺化您的 API,或將使用 Swagger 2.0 定義的現有 API 轉換為最新版本的規格。您也可以使用 Swagger Inspector 從現有 API 輕鬆產生 OAS 3.0 定義。請查看遷移到 OpenAPI 3.0:如何使用 Swagger 工具轉換現有的 API 以瞭解更多資訊!

立即開始