介紹 API 標準化

一種大規模設定和強制執行 API 標準的簡單方法
  2018 年 12 月 12 日

專注於 API 的團隊不斷尋求提升開發工作流程中交付新功能和更新功能的速度。在 API 設計方面,團隊可以採取的最重要步驟之一,以提高效率並改善其 API 程式的可擴展性,就是強制執行通用的設計標準。

有許多不同的方法可用於協助團隊設定和強制執行通用標準,包括使用程式碼檢查器、樣式驗證引擎(許多是內部建置的),甚至手動審查流程。在某些情況下,此審查流程可能需要整個團隊專門負責驗證 API 設計或審查程式碼。

雖然這些方法在處理一小組 API 時可能有效,但沒有一種方法可以很好地大規模運作。事實上,當我們最近調查一群 API 開發人員關於他們最希望在未來一年內解決的 API 技術挑戰時,標準化是排名第一的回應。

今天,我們很高興在 SwaggerHub 中推出一項新功能,以協助團隊在組織層級設定和強制執行 API 標準:API 標準化

API 標準化如何運作?

API 標準化有助於確保您在 SwaggerHub 中的 OpenAPI 定義符合您公司的 API 樣式指南。組織擁有者可以選擇各種規則,以檢查操作、參數和模型定義是否符合規範。這些規則可以應用於在其組織內開發的所有 API。

每次儲存新版本的 API 時,SwaggerHub 都會自動驗證 API 是否符合標準。這表示無論專案或團隊為何,都可以在實際實作開發並上線之前,在 API 設計流程的早期偵測和修復不一致之處。

將 API 標準化新增至您的工作流程

SwaggerHub 的設計旨在輕鬆融入您現有的 API 開發工作流程。如果您今天在 API 設計流程中使用現有的標準集,您可以在此處檢查這些角色是否在 SwaggerHub 中受到支援。API 標準化也可以與我們強大的可重複使用網域結構結合使用,讓您可以使用可重複使用資產的程式庫,在幾分鐘內建立新的設計。

或者,如果團隊在「程式碼優先方法」的建置或部署流程中產生定義,則可以將該定義推送至 SwaggerHub 並驗證其是否符合組織要求,而先前可能需要其自身的管道或流程。

雖然我們很高興推出此功能,但這只是為團隊和組織提供更多高階功能的第一步。預計在明年年初看到更多關於 API 標準化的消息,以及更多旨在加速任何規模團隊的 API 設計和開發流程的功能!

查看實際運作的 API 標準化

API 標準化在 SwaggerHub 的 企業方案中提供。

在 12 月 13 日星期四,我們將舉辦免費培訓,其中包括 SwaggerHub 中新 API 標準化功能的現場示範。此網路研討會使用 Swagger 大規模建置和強制執行 API 標準,將探討團隊在大規模設計 API 時面臨的挑戰,並將介紹組織可以採取哪些步驟來標準化 API 設計。

立即註冊