我們知道設計完美的 API 並非易事。每個 API 都是經過精心設計,並採取措施來確保品質和功能。API 定義格式(例如 OpenAPI (先前稱為 Swagger))為此流程提供標準化,即開發團隊描述和決定每個 API 應如何運作的合約。但是,確保 API 品質並非在設計 API 後就結束。
您 API 的品質應超越部門障礙,如此您才能知道您的 API 持續提供其設計的價值。透過監控您設計的 API,無論是監控預生產環境或生產環境中的 API,您都能全面了解該 API 的效能和行為。
監控您的 API 可以獲得什麼?
監控工具可深入了解您的 API 如何運作。了解您的設計如何實現、運作,以及長期以來的效能,將有助於:
最終,監控您的 API 有助於您改進。透過在終端使用者之前發現問題、接收有關 API 效能、可用性和正確性的意見反應和可操作的資料,您可以不斷創新並推動更高的採用率。
那麼,什麼是綜合監控工具?
綜合監控是一種主動式監控數位資產的方法。綜合監控工具會透過執行您的應用程式或 API 將執行的主要動作或交易來模擬真實使用者。綜合監控不是監控真實使用者互動,而是為組織提供一種監控使用者將會遇到的情況的方法,以便在真實使用者遇到問題之前,可以發現並修復任何問題或效能偏差。
API 監控通常分為兩種類型:API 端點監控和 API 交易監控。API 端點監控可確保每個端點都正常運作,而 API 交易監控則支援多步驟監控,從序列中的每個步驟擷取資料。
這對 API 開發團隊而言意味著什麼?
越來越多公司認識到設計作為軟體開發生命週期中必要部分的價值。但是,很少有公司能夠成功地在其業務結構的其他要素中利用這些設計。
作為開發人員,確保您建立的成品(例如 OpenAPI 規格檔案)在您的公司中得到正確使用至關重要。了解 API 生命週期中的後續步驟有助於改善您的設計流程以及後續的流程。為了實現真正的 DevOps 文化,協作和互通性至關重要,而開發團隊是支持 DevOps 計畫的關鍵要素。
重複使用 OpenAPI 規格檔案來監控您的 API
當您設定 API 監控時,根據您使用的工具,您必須指定要檢查的端點或交易,有時這可能需要額外的資源來製作詳細的指令碼來重新測試 API。我們了解,對於支援 CICD 計畫和敏捷流程的團隊而言,這絕非選項。
這就是為什麼我們很高興宣布 AlertSite (SmartBear 的綜合監控工具) 的朋友們已推出支援重複使用 OpenAPI 規格檔案來建立新的 API 監控。這使其可以監控您使用 Swagger 工具設計的 API 的效能、可用性和功能正確性。 AlertSite 可協助您在幾分鐘內開始運作,而無需額外的程式碼要求。
透過此新的整合,您的開發團隊可以簡單地將任何現有的 OAS 定義 (目前支援 OAS (或 Swagger) 2.0) 交給營運團隊,以自動產生監控,以確保 API 按預期運作。或者,更好的是,開發團隊可以利用 OAS 定義在預生產環境中建立新的監控。
為什麼這很重要?
當在 DevOps 環境中工作的組織可以重複使用現有資產時,可以減少部署過程中的摩擦並消除不必要的障礙。遵循「設計優先」的 OAS 方法需要詳細規劃每個 API 功能的期望和需求,因此能夠以減少部署時間和平均解決時間的方式執行至關重要,這對敏捷團隊而言至關重要。
另一個主要好處是透過利用 API 定義建立新的監控所帶來的跨職能協作和一致性。隨著 API 的發展和新版本的發布,開發和營運團隊可以繼續重複使用 OAS 定義來更新監控,確保 API 繼續按預期運作。
為了擴展其 API 監控功能,AlertSite 的 OpenAPI 規格支援讓開發人員和營運團隊可以輕鬆確定他們所依賴的 API 的狀態和行為。AlertSite 使 DevOps 團隊能夠持續監控異常情況,並發送帶有可操作、情境資料的目標警示,以便快速解決任何問題,確保您的 API 不僅可用,而且還能提供其設計中設想的體驗。此增強的 AlertSite API 監控功能只是眾多功能中的第一步,並且計畫在 2018 年推出令人興奮的新整合和功能。
感謝您的閱讀!正在尋找更多 API 資源嗎?訂閱 Swagger 電子報。每月收到一封包含我們最佳 API 文章、訓練、教學課程等的電子郵件。訂閱