全部產品
Search
文件中心

DataWorks:使用函數作為API過濾器

更新時間:Jun 19, 2024

本文為您介紹如何使用函數作為API的前置或後置過濾器。

前提條件

背景資訊

您可以在資料服務中建立函數、測試函數、發布函數,發布後的函數可被進一步關聯至API,作為API的過濾器,對API的請求參數或返回結果進行加工處理,從而實現API的複雜查詢需求,靈活適配各類業務情境。常見情境的程式碼範例請參見:使用Aviator函數作為過濾器的最佳實務

使用限制

  • 當使用函數作為API過濾器時,前置過濾器和後置過濾器的函數類型需要保持一致。即:均選擇Aviator函數類型或Python函數類型。暫不支援對同一API的前置和後置過濾器選擇不同的函數類型。

  • Python函數正在改造中,暫不支援建立、複製和發布新的Python函數。

使用函數作為API的過濾器

  1. 服務開發頁面,展開目標API所在的商務程序 > API

  2. 雙擊相應的API名稱,開啟該API的編輯頁面。

  3. 單擊頁面右側的過濾器

    根據需要勾選使用前置過濾器使用後置過濾器函數類型預設為Aviator函數,單擊前置過濾器或後置過濾器右側的下拉框選擇目標函數(可添加多個函數,執行時會按照函數的添加順序對API參數進行處理)。

    說明
    • 過濾器由一個或多個函數組成,允許您對API的請求參數進行預先處理或對查詢結果進行二次加工。

    • 若在下拉式清單中無法擷取目標函數名稱,請檢查目標函數是否發行,或嘗試建立函數並發布。詳情請參見發布函數

  4. 單擊API返回結果預覽,查看使用過濾器後的結果是否符合預期。