日本熟妇hd丰满老熟妇,中文字幕一区二区三区在线不卡 ,亚洲成片在线观看,免费女同在线一区二区

API結果過濾器

同個API在不同使用的場景中,默認的返回結構不一定能夠滿足調用者實際的需求,因此我們支持通過配置過濾器的方式,使用戶可以對API返回的原始結構進行靈活的轉換,減少用戶API對接及二次開發的成本。

使用方式

正確配置過濾器并生效后,會對返回結果自動進行格式轉換。

結果示例

某個API原始返回結構如下:

image.png

  • code:返回狀態碼 SUCCESS/ERROR。

  • data:返回的數據,根據數據源類型不同結構也可能有所不同,一般為ArrayList或者jsonObject結構。

  • traceId:本次調用追蹤的唯一ID。

  • message:當code為ERROR會在message里返回錯誤原因。

?

現在API使用者希望去掉code、traceId等字段的封裝只返回其中data的部分。當正確配置過濾器后,返回結構如下:

image.png

可以看到返回結果中只剩下了data字段里的內容,無需用戶再手動轉換。

配置方式介紹

API開發過程配置過濾器

?在API開發過程中配置過濾器,配置完成后對所有調用都會生效。?

使用方式:

image.png

在API創建/編輯過程中,第三步【API配置及測試】頁面,點擊【返回內容】左上方【過濾器】按鈕啟用過濾器。

過濾器有兩種設置方式:

  1. 格式處理:使用指定的方式對返回結果進行處理,分別是過濾code字段、過濾message字段、過濾traceId字段以及僅返回data內容,支持多選

  2. 自定義邏輯:使用自定義腳本的方式,對整個返回數據的結構進行轉換。目前支持js函數,后續會開放對更多種腳本語言的支持

自定義邏輯的js函數腳本示例:

function filter(response) {
  // 獲取返回結果data中第一組數據
  var data = response.data[0];
  // 拼接證件號碼和客戶名稱后返回結果
  return data.zzhm + " : " + data.khmc;
}

使用上述腳本執行轉換的結果:

image.png

設置完成后過濾器生效,關閉過濾器按鈕后之后失效。

已獲授權API配置過濾器

調用者對于獲得授權的API,可以再單獨設置一個過濾器,此過濾器只有在當前獲得授權的應用調用API時才會失效,不會影響API本身的返回結構,也不會影響其他的應用對該API調用。

使用方式:

在【已獲授權API】列表頁,找到對應獲得授權的API,點擊右側【操作】功能列中的【測試】,進入已獲授權API測試頁。

image.png

在已獲授權API【測試】頁面,點擊打開【過濾器按鈕】,便可配置過濾器,配置的方法和API開發過程的過濾器相同。

image.png

說明

如果一個獲得授權的API已經在開發過程中開啟了過濾器,那么再開啟應用授權過濾器后,兩個過濾器會同步生效:應用授權過濾器會對API由過濾器轉換后的結果,按照設置的方式進行再次過濾,最終返回給調用方。