隆重推出全新 SwaggerHub 編輯器:更智慧的編輯器,加速 API 設計

  2017 年 3 月 7 日

SwaggerHub 一直以來都專注於提供最快速且最易於使用的平台,讓您使用 Swagger 設計、記錄和建置 API。SwaggerHub 平台的核心是一個強大的雲端編輯器,可讓您透過適量的回饋和協助來設計和記錄 API。自從推出 SwaggerHub 以來,我們收到了許多使用者的回饋,了解他們最需要編輯器的哪些功能,以及我們如何更好地改進編輯器的功能以滿足他們的需求。 在過去幾個月中,SwaggerHub 團隊一直努力根據我們收到的回饋實施多項重大改進。除了在編輯器中推出的一些新功能外,幕後還進行了大量工作,以提高編輯器的速度和穩定性,確保所有大小的 Swagger 檔案都能順利完成設計工作流程。 立即登入以親自試用新的 SwaggerHub 編輯器。(還不是 SwaggerHub 使用者嗎?免費註冊。) 以下是 SwaggerHub 編輯器中新增功能的詳細介紹,以及這些新功能如何協助您在 SwaggerHub 中設計更好的 API。

全新的整合編輯器

SwaggerHub 一直以來都提供在編輯器中輕鬆切換 API 的 YAML 語法,以及 UI 中產生的互動式 API 文件的功能。但我們也收到使用者的回饋,表示他們希望能夠獨立使用編輯器和 UI。因此,在新的 SwaggerHub 編輯器中,我們新增了在分割檢視、僅限編輯器和僅限 UI 檢視之間切換的功能。 您可以輕鬆調整編輯器的大小,讓您可以更輕鬆地使用 Swagger 定義。並透過按一下畫面頂端的顯示標籤來切換檢視。 SHSplit

透過智慧型自動建議加快編輯速度

SwaggerHub 編輯器提供語法自動完成功能,有助於加快設計過程並減少撰寫語法時的常見錯誤。改進後的編輯器透過擴展自動建議功能,並提供更智慧型的自動建議,將速度提升到 API 設計過程的最前線。 當您撰寫時,您仍然會看到 SwaggerHub 編輯器中一直可用的自動產生的程式碼片段和關鍵字,但您也會看到更具體的建議,這些建議基於您正在使用的規格部分。例如,如果您正在更新 Swagger 定義中的「schemes」,則新編輯器會建議與該值相關聯的陣列項目。或者,對於標籤之類在陣列下具有對應的項目,您只會取得陣列項目,然後您可以從中選取關鍵字。 autosuggest1 您也可以隨時按一下「ctrl+space」來檢視建議。

更具行動性的錯誤訊息

SwaggerHub 編輯器一直以來都提供即時驗證和錯誤訊息,以協助您完成設計過程,並確保您符合 Swagger (OpenAPI) 標準。該團隊一直努力了解人們在撰寫 Swagger 定義時遇到的最常見錯誤,並已更新錯誤警告,以提供更具行動性的深入資訊,以協助在錯誤發生時修正錯誤。 我們已發布第一輪更新的錯誤訊息,並將在未來版本中繼續更新這些訊息,以滿足 Swagger 使用者的最常見使用案例。 Validator Error

規格同一行上的多個註解

團隊可以使用 SwaggerHub 來協同設計和記錄任何 API。SwaggerHub 編輯器現在提供一項小巧但廣受好評的協作改進,那就是能夠在規格的單行中撰寫多個註解。 Comments 這讓處理 API 的隊友能夠在規格的同一行上提出個別問題、註解、提供回饋,並追蹤個別對話的完成情況。

親自試用新的編輯器

我們很高興推出 SwaggerHub 編輯器的這些最新更新。立即登入以親自試用 有任何意見/問題/回饋嗎?請在下方留言讓我們知道。