1. 概述
1.1 版本
FineDataLink版本 | 功能變動 |
---|---|
4.0.28 | 資料發佈 API 參數支援傳入 NULL 值 |
1.2 應用場景
使用者想要在發佈 API 時,對 API 取數邏輯進行設定:取出發佈的 API 中為 NULL 的資料,同時也能正常查詢其他資料。
FineDataLink 支援 API 參數傳入 NULL 值。
2. 操作步驟
本文範例:將「訂單表」中的資料發佈為 API,並在取數時可取出貨主省份為 NULL 值的資料,同時也能正常查詢其他資料。
2.1 建立API
進入「資料服務」,建立 API 。如下圖所示:
2.2 輸入API資訊
1)輸入 API 名稱,API 描述可為空,本文範例中請求方式選擇 post,請求 Body 格式選擇 application/json ,設定路徑,將建立的 API 新增至應用中。如下圖所示:
當然若此時沒有建立應用,可不新增應用,在完成 API 建立後,在應用列表中綁定 API ,詳情參見:綁定API至應用
注:API 的路徑、請求Body格式等基本資訊詳情參見:發佈API
2)點選「下一步」按鈕。
2.3 設定發佈內容及參數
1)選擇要發佈的資料源以及資料連結,然後輸入查詢 SQL 語句;請求參數配置中,「參數必填」按鈕關閉,即參數可以為空,參數預設值為 NULL。
SELECT * FROM `demotest`.`訂單表` WHERE IF('${province}'='NULL',貨主省份 IS NULL,貨主省份 ='${province}')
該參數在 API 發佈後,可在透過 API 取數時使用 SQL 語句設定的參數進行條件取數。
注1:範例為 MySQL 資料庫文法,不同資料庫的文法不同,使用者可根據實際使用資料庫類型修改文法。
注2:該步驟中,各設定項介紹請參見:發佈API概述
2)點選「獲取」按鈕,輸入 NULL,可查詢「貨主省份」為空的資料。如下圖所示:
輸入「北京」,可查詢「貨主省份」為北京的資料。
3)點選「下一步」。
2.4 預覽測試
1)進入「預覽測試」步驟中,可在 Body 中填入參數值,如下圖所示:
點選「測試呼叫」按鈕,即可看到測試API傳回結果。如下圖所示:
2)點選「生成API」即可完成 API 生成。如下圖所示:
2.5 API上線
右上角點選「上線」,即可發佈 API,如下圖所示:
3. 後續步驟
若使用者在發佈時沒有將 API 新增至指定應用,也可以在 綁定API至應用 中將上線的 API 透過應用進行管理,以便能夠被呼叫。
若需要使用已經發布的 API,詳情參見:使用資料服務發佈的API(POST application/json請求)
可看到取出參數為 NULL 值的資料,如下圖所示:
對已經發布的 API 進行管理,詳情參見:服務維運