DigiRunnerAPI組合與設計
壹、 什麼是Composer?
DigiRunner(TSMP) API COMPOSER,一款基於Node.js並門用在物連網的視覺化套件。DigiRunner(TSMP) API COMPOSER透過設計界面,進行既有 API 之組合與串接API Merge無限延伸應用(輕量開發快速組合、圖形式開發介面、平台API輕鬆引用)。
圖1.TSMP登入
一、進入Composer操作:
(一)登入TSMP。
(二)點擊API管理àAPI組合與設計。
圖2.API組合與設計(Composer建立)
二、進入Composer操作:
(一)輸入模組名稱。
(二)輸入API Key(不可與模組名稱相同)。
(三)勾選methods(必勾)。
(四)輸入API說明。
(五)點擊Composer。
圖3.進入Composer
三、進入Composer畫面:
(一)系統預設http in、http response節點。
參、介紹Composer應用
一、API傳參數進DB取資料
圖4. API傳參數進DB取資料
操作:
拖曳function:
(一)http in/response。
(二)debug(收到request,並偵錯)。
(三)MSSQL(連結TSMPDB)。
圖5.各節點資訊
操作:
(一)http in請求方式為POST。
(二)debug(命名api request,輸出msg.payload)。
(三)MSSQL輸入connection資訊、Query。
(四)debug(命名msg,輸出完整資訊)。
圖6.Sample Code
操作:
(一)按下部署,至API測試區。
圖7.API測試區
測試操作:
(一)Token:輸入用戶端編號、密碼。
(二) TSMP URL:輸入註冊於TSMP的URL路徑。
(三)Http Method:為「 POST 」。
(四)請求表身:為JSON格式。
(五)發送請求。
圖8.API測試區-回應
測試結果:
JSON輸入{”id”:”01”}後,回傳name:松山區。
圖9.Composer-debug視窗
操作:
(1)回到COMPOSER。
(2) debug視窗出現db11251內容。
圖10.API組合與設計(Composer)建立
操作:
輸入已註冊的氣溫API基本條件後,將氣溫與濕度兩支API組合為同支API。
(一)模組名稱
(二) API Key
圖11. API組合與設計(Composer)建立
操作:
輸入完基本條件後,至回應區點選COMPOSER進行API組合與設計。
圖12.氣溫、濕度組合
操作:
拖曳function:
(一)http in/response : api name /api res
(二)http request
(三)function(暫存溫度、暫存濕度)
(四)inject(命名:時間戳記)
(五)debug(收到request,並偵錯)
圖13. 各節點資訊
操作:
(1)http in請求方式為POST。
(2)http request請求方式為GET,輸入URL(氣溫、濕度),格式皆為JSON物件。
圖14. 各節點資訊
操作:
(1)暫存溫度、暫存濕度:輸入函數。
(2) api res:為回應,無須更動屬性內容。
(3)按下「部署」。
圖15.Sample Code
操作:
(1)SAMPLE CODE。
(2) 點擊「時間戳記」,debug視窗出現response內容。
圖16.API測試區
測試操作:
(1)Token:輸入用戶端編號、密碼。
(2) TSMP URL:輸入註冊於TSMP的URL路徑。
(3)Http Method:為「 POST 」。
(4)請求表頭。
(5)請求表身:為JSON格式。
(6)發送要求。
圖17.API測試區-回應
測試結果:
查看回應是否正確。
肆、結語
API Composer應用廣泛,內建多種開發節點(格式轉換、外部資料、資料庫、功能),可組合一個以上的API、流程式操作、快速引用平台Module及連結外部API。
圖18.多種開發節點