大家都在談論 OpenAPI 3.0。您的老闆可能從某位分析師那裡聽說過它，您在附近很酷的初創公司中的朋友們使用它來更好地定義他們基於微服務的應用程式，而您擔任產品經理的表哥在上次感恩節時不停地談論它讓使用 API 變得多麼容易。
您很感興趣，並且在經過一些研究後，您已經意識到使用 OAS 3.0 定義 API 是多麼有利。但是，如果每個對 OpenAPI 讚不絕口的人在實作 API 之前都先使用規格設計了 API 呢？您的公司擁有許多在 OpenAPI 流行之前很久就已實作和部署的舊版 API。
那麼，您如何從現有的 API 建立 OpenAPI 文件？
您可能會花費數小時研究最佳外掛程式以協助您產生此規格、確保外掛程式支援實作語言，然後花費更多時間使用此外掛程式註解您的每個 API 端點，以最終建立此規格。或者，您可以使用 Swagger Inspector 的最新支援，只需點擊幾下即可產生 OpenAPI 3.0 文件。
OpenAPI 3.0 簡化
OpenAPI 永遠改變了 REST API 的格局。它為人類和機器提供了一個通用的框架，以理解、使用和消費 API。它充當開發人員輕鬆建構 API 的標準範本，詳細說明不同的資源及其相關的請求-回應週期。OpenAPI 3.0 在先前的 Swagger 2.0 規格之上帶來了豐富的其他功能，其中包括 -
- 為了更好的可重用性，重構了規格的整體結構
- 新增了描述回呼的支援
- 用於表達運算之間關係的連結
- JSON 結構描述包含以下支援：oneOf、anyOf 和 not
- 改進的參數描述，包括使用結構描述的能力
- 更好地支援多部分文件處理
- Cookie 參數已包含；dataForm 參數已排除
- Body 參數有自己的實體
- 更好地支援內容類型協商
- 簡化並增強了安全性定義
OpenAPI 3.0 定義可以協助自動化不同的 API 生命周期流程，包括建立互動式、使用者友善的文件、建立客戶端 SDK 原型和產生測試案例。
每個人都一直在尋求充分利用 OpenAPI 3.0，而且很明顯您的 API 有一些很棒的功能。但是，Swagger Inspector 的新 OAS 3.0 支援與這些有什麼關係呢？
從現有的 API 即時產生 OpenAPI 3.0
設計優先方法提倡在實際程式碼、實作、測試和文件完成之前，先使用 OpenAPI 規格設計 API。但是，儘管設計優先方法是每位開發人員都應該努力實現的理想方法，但它並不總是容易實現。
許多時候，組織都有大量已經實作和部署的現有 API，但沒有任何定義。此外，公司或團隊在未來 API 程式中可能不會優先設計 API 的原因有很多實際原因。
這就是 Inspector 的用武之地。透過 Swagger Inspector，您可以告別耗時、程式碼優先的 OpenAPI 產生困境！Inspector 允許您在幾分鐘內透過點擊幾下，從現有的 API 端點產生 OpenAPI 定義。為此，請在表單欄位中插入您想要在 OpenAPI 中定義的 API 的基本 URI 和路徑。您可以隨時新增任何驗證、標頭或查詢參數（如果需要），然後按一下 [傳送]。
在您獲得有效的回應後，您可以從右側面板上的 [歷史記錄] 標籤下產生 OpenAPI 檔案。關於 Inspector 的酷事是，您可以將多個端點合併到一個 OpenAPI 檔案中，該檔案會自動推送至 SwaggerHub（設計和文件平台），您可以在其中進一步編輯文件、產生客戶端 SDK、建立互動式文件等等！
輕鬆剖析和測試 OpenAPI 端點
開發人員在開發過程中不斷地需要仔細檢查他們的 API 和端點是否按預期運作。沒有人喜歡新的流程，尤其是開發人員。
對於使用 OpenAPI 中已定義的 API 的開發人員，Swagger Inspector 提供了一種簡單的方法來剖析 OpenAPI 3.0 檔案，查看整個 API 中的各種端點和方法，讓他們可以選擇要測試的資源。
只需插入 API 定義的位置，或上傳 OpenAPI 檔案。例如，這裡是在 SwaggerHub 上找到的以 OAS 3.0 定義的 SmartBear Petstore API。只需將此位置插入 Inspector，然後按一下 [傳送]。如果它是有效的 OpenAPI 3.0 定義，您可以使用 [使用定義] 按鈕查看 API 中的所有端點。
從這裡開始，您可以選取您想要驗證的端點和方法，並查看回應是否符合您的預期！
最後，繼續並在您的 [歷史記錄] 標籤中選取您剛剛測試的端點。從那裡，按一下 [建立 API 定義] 下拉式選單並選取 OAS 3.0。您需要建立一個帳戶才能完成定義產生。
當我們說我們了解 OpenAPI 時，我們是認真的。OAS 是推動和加速 API 開發的最佳開放標準，我們希望 Swagger Inspector 可以為您提供一種簡單的方式來開始使用 OAS 3.0 規格。
感謝您的閱讀！正在尋找更多 API 資源嗎？訂閱 Swagger 電子報。每月接收一封包含我們最佳 API 文章、培訓、教學課程等的電子郵件。訂閱