使用 Swagger Inspector 擴充功能監控私有 API

  2019 年 2 月 14 日

了解內部面向 API 在生產環境中的效能可能看似一項艱鉅的任務。事實上,直到最近,大多數團隊並未積極監控其 API。隨著近期市場的變化,越來越多團隊將 API 監控作為其營運團隊和品管團隊的優先事項,以便正確測試每個版本,並設定監控以確保此效能在生產環境中持續。我們在API 現況調查 2019中發現,將 API 監控視為最高優先事項的團隊在解決效能問題方面遠遠優於沒有這樣做的團隊。

擁有正式 API 監控流程並將監控視為最高優先事項的團隊,有 76% 的團隊能在前 24 小時內解決 API 效能問題。

SmartBear 2019 年 API 現況調查

毫無疑問,了解生產環境中發生的情況可以比從客戶那裡聽到您的 API 速度緩慢或未如預期執行時更快地解決問題。令人驚訝的是,沒有監控流程的團隊數量。SmartBear 開始研究如何讓優先考慮 API 品質的團隊更容易地執行此流程,並發現為了幫助促進 API 監控的採用,它必須無縫融入團隊目前的流程中。

什麼是 API 監控?

API 監控涉及利用監控工具,更常見的是合成監控工具,來驅動流量到您的 API 並記錄此給定流量的 API 行為。此流程使您的團隊(開發營運、營運、品管和效能)能夠深入了解生產環境中發生的情況。這對於精確找出任何速度緩慢、功能不正確和停機的根本原因非常有幫助。良好的合成監控工具能夠通知您任何效能偏差、管理 SLA,並在出現問題時提醒您的團隊。

我該如何監控我的 API,而不破壞我的發布流程?

將 API 監控整合到您的發布週期中而不中斷目前流程的第一步,是嘗試找出可以重複使用資產的地點,以及如何自動化您的 API 監控流程。如果您的團隊使用 Swagger、OpenAPI 規範或 SwaggerHub,您就已經離開始監控您的 API 更近一步。AlertSite 是來自 SwaggerHub 背後同一個團隊的合成監控工具,可以使用您的 OpenAPI 規範檔案自動建立監控。此外,在其最新版本中,您現在可以使用 Swagger Inspector 擴充功能開始監控您的私有 API。

開始針對私有(或內部面向)API 和公用 API 進行 API 監控實際上非常容易。如果您熟悉 Swagger Inspector,那會更容易。

在這種情況下,我們使用 AlertSite(來自 SmartBear 的合成監控工具)有幾個原因

  1. AlertSite 可以使用您的 OAS 檔案或僅貼上端點 URL 來自動建立新的監控。
  2. AlertSite 會監控 API 交易(驗證每個 API 呼叫,並確保整個流程執行如預期)。
  3. AlertSite 可以監控 SLA
  4. 您可以使用 AlertSite API 以程式設計方式驅動您的監控流程
  5. AlertSite 警報非常可設定、快速且準確 – 因此可以在需要時提醒正確的團隊。

使用 Swagger Inspector 擴充功能監控私有 API

Swagger Inspector 擴充功能可以讓您的瀏覽器直接連線到此端點。按一下「使用 Swagger Inspector」核取方塊,以啟用 Swagger Inspector 擴充功能並重新驗證端點。

使用 OpenAPI 規範檔案監控公用 API

若要開始監控您的公用 API,您只需要 OAS 檔案或端點 URL 即可開始。

若要開始使用,請嘗試使用 AlertSite 監控您的 API。我們提供免費 30 天完整功能試用,讓您了解它如何為您的團隊運作。