接口
組件數據源選擇為接口時,可將接口返回結果設置為組件展示的數據。目前支持的接口來源有數據服務API、自定義接口、業務邏輯開發、產品與物的管理。本文介紹接口數據源的參數配置。
前提條件
已在配置組件數據源時,選擇數據源為接口。
各組件數據源的配置操作,請參見本產品文檔中
目錄下的各組件文檔。數據源配置說明
參數 | 說明 |
選擇數據源 | 選擇接口。 |
接口來源 | 可選:
說明 部分圖表組件和重復列表組件配置接口數據源時,支持的接口類型為數據分析服務、自定義接口和業務邏輯開發。具體內容,請參見組件文檔。 |
請求方法 | 選擇自定義接口的請求方法,可選:get、post。 當接口來源選擇為自定義接口時出現的參數。 |
請求地址 | 輸入您的自定義接口的請求地址。 當接口來源選擇為自定義接口時出現的參數。 |
選擇接口 | 選擇要調用的接口。 當接口來源選擇為數據分析服務、業務邏輯開發或產品與物的管理時出現的參數。 |
請求參數 | 可選:
|
返回結果 | 單擊驗證數據格式或確定時,系統都會調用該接口,請求結果會寫入到返回結果中,以供您參考。 |
數據過濾腳本 | 選中后,基于JavaScript對接口返回的原始數據進行一定的加工以適配圖表或文字的展示需求。更多信息,請參見數據過濾器。 |
數據表配置 | 選中后,對接口返回或腳本處理之后的結構化數據進行解析并排序,以決定在組件上具體顯示數據。更多信息,請參見數據過濾器。 |
處理后結果 | 經過腳本處理以及數據表配置優化之后的結果,將直接用于組件的顯示。 當勾選了數據過濾腳本或數據表配置時出現的參數。 |
保存返回結果到頁面變量 | 選中后,在服務調用時可以將接口調用的返回值保存為頁面變量,也可以從已有的頁面變量列表中進行選擇,單擊新增頁面變量按鈕,對頁面變量進行管理,包括頁面變量的新增、編輯、刪除。 |
定時刷新 | 選中后,需指定每隔多少秒自動調用接口一次,以獲得最新數據。默認不開啟。 重要 對于控制組件和表單組件展示內容或狀態,如果用戶手動更新的組件內容或狀態與定時刷新的接口數據源返回結果不一致,則組件展示內容或狀態以更新的接口數據源結果為準。 |
數據格式說明
不同組件支持返回數據格式不同,其中需注意的組件有:
表格組件
如果接口返回的數據格式和靜態數據中的格式相同,則是否分頁展示的規則也相同。
接口數據源也支持動態返回每頁的內容,如果開啟表格組件的分頁器,需要滿足以下要求:
接口請求參數需包含:pageSize(每頁記錄數);pageNo(當前頁碼,第一頁從1開始)
接口返回參數需包含:pageSize(每頁記錄數);pageNo(當前頁碼,第一頁從1開始);total(總記錄數,可不傳。不傳時,目前會影響表格組件的分頁器顯示)
說明以上參數名的字母大小寫需與此處描述保持一致。
組件調用接口時將自動傳遞pageSize和pageNo參數,如果接口支持返回分頁數據,則數據必須滿足以下的格式:
{ "pagination":{ "pageSize": 3, "pageNo": 1, "total":6 }, "data": [ { "month": "Jan", "sales": 300, "cost": 150 }, { "month": "Feb", "sales": 300, "cost": 150 }, { "month": "Mar", "sales": 300, "cost": 150 } ] }
total表示所有數據的總條數,表格組件將根據這個數字和每頁的條數顯示分頁,data表示當前頁的數據,格式和上方靜態數據源中一致。
重要建議data中的數據個數和參數中的pageSize保持一致,如果不一致,會導致表格的分頁器無法正常展示。
支持配置靜態數據源的表單組件
接口返回數據需與靜態數據的數據格式要求一致。更多信息,請參見靜態數據。
說明如果接口返回數據不滿足要求,可使用數據過濾腳本功能處理數據。
操作 | 說明 |
格式參考 | 單擊格式參考,查看組件支持的數據格式。 |
驗證數據格式 | 單擊驗證數據格式,驗證當前數據格式是否滿足組件的格式要求。滿足要求,則提示“驗證成功”;不滿足,則會提示詳細的錯誤信息。 |