顯示資料服務API呼叫詳情

1.1 版本

1.2 應用場景

IT 發佈一個資料服務API給業務人員呼叫，業務人員反饋“API報錯”或“資料不對”時，需要快速定位問題根源，並界定是 API 本身的問題，還是呼叫方傳參錯誤。

目前 IT 人員無法看到呼叫者實際傳入的 Request Body 和系統傳回的 Response Body，導致雙方對請求體和回應資料的正確性各執一詞，卻無法還原呼叫事實。

1.3 功能簡介

1）支援為單個資料服務 API 配置呼叫詳情，API 被呼叫後，可查看呼叫 API 時的請求內容、傳回內容、SQL詳情。

2）支援超管配置呼叫詳情儲存策略。

2.1 場景模擬

IT 發佈一個資料服務API給業務人員呼叫，業務人員反饋“API報錯”或“資料不對”時，需要快速定位問題根源，並界定是 API 本身的問題，還是呼叫方傳參錯誤。

2.2 設定呼叫詳情儲存

注：需要有該 API 的管理權限；適用於資料查詢 API 和資料接收 API，本節以資料查詢 API 為例。

1）IT 人員進入 API 的詳情頁，點選右上角「呼叫詳情儲存」按鈕，進行配置。如下圖所示：

2.3 再次呼叫 API

業務人員可再次呼叫 API。

2.4 查看呼叫詳情

IT 人員，點選「維運中心>服務監視>對應API的呼叫詳情」，查看呼叫時的請求內容、傳回內容、SQL詳情，排查問題原因。

• 當 API 呼叫失敗且未配置「呼叫詳情」時，僅顯示「報錯詳情」Tab。

• 當 API 呼叫成功且未配置「呼叫詳情」時，「呼叫詳情」欄顯示為 – ；配置「呼叫詳情」後，展示三個Tab：請求內容、傳回內容、SQL詳情。

• 資料接收 API 不顯示「SQL詳情」Tab。
  

2.5 後續步驟

問題排查後建議將 API 呼叫詳情儲存範圍更改為「僅異常呼叫」，否則將佔用大量儲存空間。

3.1 設定儲存策略

超管登入 FDL 工程，點選「資料服務>服務設定按鈕>呼叫詳情儲存」，可設定呼叫詳情的儲存位置、保留時間、儲存上限。如下圖所示：

注：適用於資料查詢 API 和資料接收 API。

3.2 呼叫詳情儲存形式說明

API 得呼叫詳情儲存在%FDL%/webroot/WEB-INF/dpworks/ds_call_detail_files資料夾下，以 JSON 檔案的形式進行儲存，根據uuid 命名。