在這種分散式基礎架構中,有很多 API 將各種元件整合在一起。Bonotel 使用 Swagger (OpenAPI) 規格來定義這些不同的服務。
在 Swagger 之旅的開始,團隊使用開源 Swagger 工具來設計、建置和記錄 RESTful API。但是,當需要跨內部和外部團隊擴展 API 開發時,他們很快就面臨了挑戰。鑑於他們的 API 開發範圍廣泛,有如此多的利害關係人在他們的 API 程式中工作,因此越來越難以集中管理他們的所有 API 資產。
利害關係人無法輕鬆快速地在正確的時間存取正確的 API,同時在新 API 定義上進行協作而不會混淆,這影響了他們整體 API 交付速度。一度,Hastings 和他的團隊甚至考慮建置一個自訂元件,該元件可以視覺化儲存在其版本控制系統中的 API 定義,以便 Bonotel 的內部和外部人員可以集中存取它們。
Hastings 指出:「隨著我們進一步深入專案,我們意識到需要加快流程並使其更有效率。」「我們希望自動產生使用者介面,並促進內部和外部團隊之間的協作,而不會產生麻煩或溝通問題。」
Hastings 希望改進的另一個關鍵功能是追蹤不同 API 版本的能力。團隊越來越難以追蹤不同版本中 API 的所有更新。
Hastings 解釋說:「我們所有的 API 都是私有的,我們使用精細的存取控制來開放我們的 API,以便我們的合作夥伴可以檢視它們。」「我們也為我們的合作夥伴建立使用者帳戶,透過這些帳戶,我們可以在適當的情況下授予他們編輯權限。由於有這麼多人處理 API,我們需要密切追蹤不同的版本。」
從開源 Swagger 工具切換到 SwaggerHub
在使用開源版本的 Swagger 幾個月後,Hastings 開始尋找他的團隊需要的更穩健的解決方案。一位熟悉 Swagger 技術的 Bonotel 合作夥伴推薦了 SwaggerHub。SwaggerHub 是 SmartBear Software 的整合 API 設計和文件平台,由 Swagger 背後的團隊建置。在評估該平台後,Bonotel 很快就將 SwaggerHub 確定為其 API 開發工作流程的關鍵工具。
對於 Bonotel 而言,SwaggerHub 為內部開發人員和外部利害關係人之間的 API 設計、文件和開發需求提供了中央平台。 SwaggerHub 事實上是為 Swagger (OpenAPI) 規格中的 API 開發量身訂製的,這讓 Scott 和他的團隊可以輕鬆地將他們的 API 設計和開發轉換到 SwaggerHub 中。
Hasting 指出:「我們過去使用開源 Swagger 工具鏈,但由於 SwaggerHub 是圍繞核心 Swagger 技術建置的,因此很容易採用該平台,而且我們這邊的額外負擔有限。」能夠無縫探索現有 API 或處理新 API,使 Bonotel 的開發團隊能夠在其 API 工作流程中實現一致性和紀律。
Hastings 說:「在內部檢閱該工具並了解 SwaggerHub 如何增強已經根深蒂固於我們開發生命週期的基本開源 Swagger 功能後,我們立即意識到該解決方案將滿足我們的需求。」 「SwaggerHub 運作良好,我們沒有考慮任何其他替代方案。」
透過 Swagger 改變 Bonotel 交付 API 的方式
作為建立 API 的工具框架,SwaggerHub 為 Bonotel 提供了一個用於設計和記錄 API 的中央平台。由精細且安全的存取控制支援的集中式 API 開發,使 Bonotel 可以自信地向外部合作夥伴開放該平台,以推動其策略目標。Scott 觀察到的一個顯著變化是,使用 SwaggerHub 後協作變得更加簡化。即使是各個團隊之間的溝通也明顯更好。SwaggerHub 註解讓 Bonotel 的內部和外部團隊不僅可以即時交流重要的想法或建議,還可以追蹤其 API 設計和文件中需要解決的未解決問題。
Hastings 強調說:「SwaggerHub 大大改善了我們內部團隊和外部合作夥伴之間 API 開發的溝通。」「這至關重要,因為我們不會在內部進行大量的 API 開發,大部分工作都是透過我們的合作夥伴完成的,他們也會彼此合作。SwaggerHub 作為所有活動部件之間協作的集中式主機,使流程非常有效率、直觀且無縫。」
減少 API 開發中的混淆
Bonotel 的內部開發和 QA 團隊以及外部合作夥伴都使用 SwaggerHub 來有效協作並作為一個單位一起工作。SwaggerHub 解決方案不僅為他們節省了大量 API 開發時間,還消除了協作時的混淆和效率損失,並抽象化了否則將與託管具有正確存取控制的 API 文件相關聯的基礎架構考量。SwaggerHub 還允許 Bonotel 追蹤 API 的新變更和更新。在視覺化比較和合併功能支援下,SwaggerHub 版本控制機制確保 Scott 和他的團隊確切知道哪個 API 已更新,以及已將哪些變更新增至更新的 API。
現在,SwaggerHub 成為內部團隊和外部開發人員之間的主要協作工具,Hastings 和他的團隊現在可以遵循 API 優先的開發方法。
Hastings 補充說:「這使事情變得更加清晰。」「我們可以將 API 的設計和文件與集中式、安全的託管環境中的協作結合起來。」Hastings 說:「透過讓我們能夠更快地設計和開發 RESTful API,我們可以更快地將新服務和服務更新推向市場。」「這使得 SwaggerHub 成為我們軟體開發生命週期的關鍵組成部分。」
改變您的團隊一起設計和記錄優質 API 的方式
對於 Bonotel 而言,轉換到 SwaggerHub 的好處是顯而易見的。這些好處包括
- 將 RESTful API 設計和文件結合在一起,以實現協作開發
- 允許團隊順暢地協同工作,而不會產生任何混淆
- 使用 SwaggerHub 註解啟用各個利害關係人之間的輕鬆溝通
- 促進版本控制,以輕鬆地將新更新新增至現有 API
- 提高新 API 和服務的上市速度
改變您的團隊一起設計和記錄 API 的方式。 立即免費試用 SwaggerHub!