Skip to main content
Version: 2.8.1

API 註冊上架

環境資訊#

API 服務主機位址: http://svc.hello.goc:80
API Gateway Proxy: http://proxy.apigw.goc:8000

欲註冊的 API 服務共包含兩支 API，分別為 http://svc.hello.goc:80/api/v1/hello_word 及 http://svc.hello.goc:80/api/v1/hello_apigw

API 單獨註冊範例#

建立服務#

要註冊 API 到 API Gateway 上時，首先需要將 API 服務的資訊新增到 API Gateway 之上：

  1. 點擊進入『服務列表』頁面
  2. 點擊『新增』按鈕
  3. 填入 API 服務主機資訊

新增服務

建立 API 路由#

新增完 API 服務後，點擊『編輯』按鈕進入服務編輯頁面

編輯服務

  1. 點擊『路由』頁籤
  2. 點擊『新增』按鈕，建立路由
  3. 填寫新增 API 路徑後送出，即完成 API 的上架流程

新增路由

測試經由 API Gateway 呼叫 API#

測試上述註冊的兩支 API 都可以正常呼叫

API測試1 API測試2

採 API 路徑前綴方式註冊多支 API 範例#

建立『前綴路徑』匹配規則的路由#

  1. 新增路由，將路徑設置為 /api/v1/hello_world 及 /api/v1/hello_apigw 兩支 API 的共同前綴路徑 /api/v1

新增前綴式路由

  1. 刪除前文新增的路由

刪除路由

  1. 測試採用前綴路徑註冊後仍可以成功呼叫代理 API

API測試前綴

自定義 API 路徑範例#

為 API 路由添加『自訂前綴路徑』#

  1. 新增路由時填入自訂的路徑
  2. 須啟用『拆分路徑』

API自訂前綴

  1. 測試採用自訂路徑後的 API，需在呼叫時增加自訂路徑

API自訂前綴

隱藏 API 路徑範例#

設置服務『根路徑』#

  1. 點擊服務『資訊』頁籤進入編輯頁面
  2. 在服務的『路徑』欄位添加根路徑

服務根路徑

  1. 測試添加『根路徑』後的 API 呼叫，可以不用再填入原始 API 的根路徑

API自訂前綴

進階 API 轉換範例#

利用 Request Transformer 外掛將 Header 轉換為路徑參數#

有一支 API 為 http://svc.hello.goc:80/api/v1/hello/:input， 路徑參數 input 可帶入任何值，API 的輸出結果會是 Hello ${input}! 此範例欲將路徑參數 input 改為由 header 帶入

  1. 首先建立此 API 專用路由

建立API路由

  1. 進入路由編輯頁面

路由編輯

  1. 點擊『外掛插件』頁籤進入外掛列表頁面，接著點擊『新增外掛插件』按鈕

路由外掛

  1. 選擇『轉換』類外掛，再啟用『Request Transformer』外掛，
  2. 選擇『取代』項目，將 URI 的路徑參數改為接收 header 參數後，送出即完成設定

路由外掛

  1. 測試可將 header 參數轉換為路徑參數發往原始的 API 服務主機並得到回應 路由外掛