在 SwaggerHub 中導入自動模擬

  2016 年 3 月 18 日

自從整合功能推出以來,SwaggerHub 團隊不斷努力為您的 API 專案帶來最好的工具。雖然 SwaggerHub 編輯器本身是一個強大的工具,可以編寫和視覺化您的 Swagger 定義,但如果設計人員可以快速迭代 API 的實際行為,則可以大大改進設計過程。從用戶端的角度來看,使用 API 的外觀和風格是構建出色 API 的開始,而我們的最新整合正是允許這樣做 – Smartbear VirtServer 整合!VirtServer 是 SmartBear Ready! API 虛擬化產品的一部分。SwaggerHub 中的 VirtServer 整合將基本 virt 功能直接整合到 API 生命週期中。啟用後,VirtServer 整合會自動建立和維護在 SwaggerHub 中定義的 API 的半靜態模擬。此模擬會在您每次儲存 API 時更新,這表示您不再需要尋找和使用外部工具來建立模擬服務。您可以透過 VirtServer 產生的預覽,有效率地與團隊迭代設計,只需按幾下滑鼠即可。

啟用 VirtServer

就像 SwaggerHub 的 GitHub 同步或 Webhook 整合一樣,SmartBear VirtServer 整合可以從右上角的「管理整合」選項新增至 API。管理整合圖片 當您看到新增和設定整合是如此容易時,您就能體會到 SmartBear VirtServer 整合的真正實用性。以下是您可以用來根據您的設計需求優化 VirtServer 的欄位

  • 名稱:這是特定的 VirtServer 整合將被稱為的名稱。
  • API 權杖:一旦指定任意 API 權杖並啟用整合,對模擬伺服器的每個請求都需要在授權標頭中包含此權杖。這僅適用於 SwaggerHub 上的私人 API。
  • API 權杖:一旦指定任意 API 權杖並啟用整合,對模擬伺服器的每個請求都需要在授權標頭中包含此權杖。這僅適用於 SwaggerHub 上的私人 API。
  • 預設回應內容類型:如果 API 規格中未指定,模擬將傳回的預設回應內容類型
  • 更新主機設定:允許整合修改您的 Swagger 規格,以更新 basePath、host 或 schemes 屬性以自動指向模擬。這允許編輯器和互動式 UI 直接呼叫虛擬伺服器,以及將自動產生的用戶端 SDK 設定為指向伺服器。

VirtServer 設定 啟用整合後,模擬現在可以使用了!

產生多個已定義的回應

這個產生的模擬會為每個產生/回應訊息組合建立靜態回應。如果一個作業有多個回應,模擬將會依序循環執行它們;例如,如果一個作業有 200、404 和 500 個回應,它們將會依序傳回該作業。在考慮 API 設計時,模擬伺服器可能是一個強大的工具。無需編寫任何程式碼,您可以讓 API 消費者根據 VirtServer 開發用戶端,這保證會以相容且真實的酬載回應。更重要的是,您可以透過在您的模型定義中使用「example」結構,直接在 Swagger 定義中調整酬載。您可以從其文件中閱讀更多有關如何設定 VirtServer 整合的資訊。此整合要感謝 SmartBear Software 的員工!請關注此和其他整合的未來增強功能。如果您對新的整合有任何建議,或希望看到您的產品與 SwaggerHub 整合,請在此提出功能要求。