繁體中文
English 简体中文 繁體中文
Methodox 首頁

建立 Web API 伺服器

難度: ★★☆☆☆(中級) 收穫: ★★☆☆☆(中等) 上下文: 資料流上下文 閱讀時間: 5 分鐘

Web API 伺服器讓我們能夠通過 HTTP 協議在網際網路上公開服務。

概述

一旦理解了相關概念,製作 Web API 伺服器就相當容易。如果需要複習,請查閱知識庫中關於該主題的內容。

我們可以利用 Ol'ista 的 Web API 功能,在資料流上下文中以圖形方式開發簡單的 Web API 伺服器:

圖:提供 Web API 服務
圖:提供 Web API 服務

伺服器端

在伺服器端,只需使用 Web API Capability,配合圖引用(或嵌入的子圖)來定義端點行為:

  1. 使用 Reference 節點引用圖;
  2. 使用 Create Web API Capability 建立 API 端點。
  3. 使用 Serve 節點啟動伺服器。
圖:伺服器端的 Web API Capability
圖:伺服器端的 Web API Capability

客戶端

在客戶端,我們可以使用 Send Request 並指定相應的方法型別。

  1. 使用 Send Request 並指定相應的方法型別來傳送請求;確保 URL 與端點 URL 一致。
  2. 對於 GET,通常不需要請求體。
  3. 使用 Preview 節點在畫布上檢視結果。
圖:客戶端
圖:客戶端

完整設定

對於被引用的圖:

  1. 使用 Inputs 節點定義兩個輸入:String Map 和 String;
  2. 使用 Outputs 節點輸出單個 EndpointResponse;
  3. 使用 Make Endpoint Response 將字串值轉換為 EndpointResponse 物件。

下面展示了完整的設定。上方的兩個視窗是作為處理程式被引用的子圖。

圖:設定
圖:設定

通過 Serve 執行伺服器後,我們可以在客戶端(右下方)檢視 Send Request 的結果。

圖:執行
圖:執行

參考資料