Eolink Apikit 如何對所有 API 異常請求實時監控 ?

API 監控適合業務在網際網路上，並且使用者來自多個不同的地區，且對API的要求較高的場合，用於解決以下的問題：

1. 發現由於網路中斷或者是API響應異常等導致的服務不可用；
2. 及時對異常的API進行告警；
3. 記錄監控的日誌，方便排查。

Eolink Apikit 除了提供 API 的管理和自動化測試等功能，還提供 API 監控服務，可以為 API 設定定時撥測，並且支援多節點監控，可以從多個不同的地區節點來模擬使用者的請求進行監控。

1、建立流程監控

API 流程監控可以同時對多個 API 進行監控，你可以設定多個 API 的監控順序，資料關聯等資訊，滿足對重點業務場景、操作流程的監控。

進入場景監控設定頁面，點選  新增流程 按鈕，進入流程編輯頁面。

在流程編輯頁面中設定流程的名稱、監控環境、監控頻率、監控節點等資訊。

2、為流程新增 API

1. 新增 API

進入流程編輯頁後，點選新增  監控步驟 按鈕，在下拉選單中可以選擇從 Eolinker API Management（API 管理產品）中匯入 API 資訊，或者手動建立監控 API。

2. 設定 API 監控資訊

點選  新建空白API步驟 的按鈕，進入 API 的編輯頁後，你可以設定 API 的基本資訊、請求資訊、校驗規則等內容。

API監控的基礎資訊包括：

• API請求地址
• API分組、名稱
• 超時限制：當API的響應時間超出設定的限制時間時，系統將會自動中斷該次監控請求，並且報請求超時異常。
  
  

3. 請求頭部

你可以輸入或匯入請求頭部。批次匯入的資料格式為  key : value ，一行一條  header 資訊，如：

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/jsonDate: Mon, 30 Dec 2019 20:49:45 GMT

4. 請求體

請求體支援以下型別：Form-data（表單）、JSON、XML、Raw（自定義文字型別資料）。

5. Query 引數

Query引數指的是位址列中跟在問號  ? 後面的引數，如以下地址中的  user_name 引數：

shop/query?shop_id=001

批次匯入的資料格式為  ?key=value ，透過  & 分隔多個引數，如：

api.eolinker.com/user/login?user_name=jackliu&user_password=hello

6. REST 引數

REST引數指的是位址列被斜槓  / 分隔的引數，如以下地址中的  user_name、 user_password 引數。

/user/login/{user_name}/{user_password}

注意：只需要在URL中使用  {} 將REST引數括起來，下方的請求引數名中不需要使用  {} 。

7. 許可權校驗

如果訪問API時需要先進行身份驗證，可以在許可權校驗處填寫校驗的資訊。

3、設定 API 之間的資料關係

同一個流程裡的不同 API 之間可以進行資料關聯。比如一個監控流程裡有兩個 API：

• 門店建立（ /shop/create）：建立門店後，會得到返回引數  shop_id。
• 門店查詢（ /shop/query）:根據  shop_id 來查詢具體的門店。

我們先設定門店建立API的請求引數和預設返回結果。進入使用者登入API的編輯頁面:

然後我們設定門店查詢API。門店查詢API只有一個請求引數  shop_id， shop_id 的引數值透過門店建立API的返回結果獲得。進入門店查詢API的編輯頁面，設定門店查詢API的請求引數，點選引數值的輸入框時，上方會出現兩個按鈕，點選  引用引數值 按鈕：

在彈窗中選擇要繫結的API以及返回引數名稱：

點選  確認 按鈕即可將使用者建立API的返回結果繫結到門店查詢API的請求引數中。

在執行流程監控的時候，系統會自動將門店建立API的  shop_id 的返回引數動態繫結到門店查詢API的請求引數中：

4、改變流程的 API 順序

拖動 API 列表可以改變 API 的執行順序。但是如果 API 之間存在資料關聯，則拖動步驟有可能會破壞 API 之間的資料關聯，導致無法正常獲得繫結的引數值。

5、開啟流程監控

流程建立好之後，可以在流程頁面的上方點選  開啟監控 按鈕，來開啟流程的監控：

也可以在流程列表，操作欄出點選  更多 按鈕，在下拉選單選擇  開啟監控 ：

還可以透過流程列表頂部的  批次操作 按鈕，來開啟監控：

生產環境可能存在同時執行多個版本的程式碼，並且每個版本的程式碼都有可能獨立迭代，最終分化出不同的版本。如果我們需要對歷史版本的API進行自動化測試，或者透過監控來驗證線上的穩定性，那麼我們可以給每一個版本的API建立一個專案。因為在 Eolink Apikit 中，我們可以為每一個專案設定監控，並且可以獨立執行測試用例，滿足複雜的API治理的需求。

瞭解更多關於Eolink Apikit 的 API 監控功能，請訪問：