使用 SwaggerHub 的比較與合併功能，改善您的 API 文件工作流程

API 描述格式（如 Swagger）充當 API 提供者和終端使用者之間的契約，以人類和機器都可讀的格式清楚詳細說明 API 的所有資源和操作。使用 Swagger 來記錄您的 RESTful API 可以讓開發更輕鬆、探索更完善，並為終端使用者帶來整體更好的整合體驗。 作為使用 Swagger 定義 API 的提供者，您有責任讓該契約保持最新，這通常需要管理多個版本的 Swagger 定義。 或者，如果您是遵循「程式碼優先」方式來使用 Swagger 的人，這表示必須使用註解從 API 的程式碼產生 Swagger 規格，您可能會發現需要進行一些調整，才能為您的 API 建立完善的定義。 無論您的團隊使用哪種方法透過 Swagger 定義 API，很可能都有許多不同技能和職責的人員參與其中。

讓適當的人員參與 API 文件

適用於您文件工作流程的正確工具

為 SwaggerHub 推出「比較與合併」功能

1. 在 SwaggerHub 中，開啟您的 API 以進行編輯。切換到需要的版本。
2. 按一下編輯器右上角的「齒輪」圖示，然後從選單中選取比較與合併 API：
3. 在後續對話方塊中，選取比較 SwaggerHub 中的規格：
4. 在下一個對話方塊中，指定使用者名稱、API 和 API 版本以進行比較：

1. 按一下下一步。SwaggerHub 將驗證 API 是否可存取。

1. 在 SwaggerHub 中，開啟您的 API 以進行編輯。切換到需要的版本。
2. 按一下編輯器右上角的「齒輪」圖示，然後從選單中選取比較與合併 API。
3. 在後續對話方塊中，選取與外部規格比較
4. 在下一個對話方塊中，輸入所需 JSON 或 YAML API 的 URL，或指定硬碟上的 API 檔案：
5. 按一下提取。SwaggerHub 將載入指定的 API 並檢查其是否有效。

1. 點擊視窗右側或左側突顯的差異行（或區塊）。SwaggerHub 會將區塊從視窗左側複製到右側（也就是您的 API），並移除突顯。同時，它也會增加「還原」按鈕中的計數器。
2. 如果需要，請點擊還原以恢復最近一次的核准。若要恢復多次核准，請多次點擊「還原」。
3. 合併所有需要的差異後，請點擊儲存變更以儲存變更。這將會取代您的 API 規格，改為變更後的版本。