查看 Apigee Edge 說明文件。
前往
Apigee X說明文件。 資訊
課程內容
透過本教學課程,你將會瞭解:
- 從 WSDL 檔案產生 Edge API Proxy。
- 瞭解符合 REST 樣式的 SOAP 代理類型與直通式 SOAP 有何差異 Proxy 上。
本教學課程將說明如何在以 SOAP 為基礎的網路前方放置 Edge API Proxy 課程中也會快速介紹 Memorystore 這是 Google Cloud 的全代管 Redis 服務
本教學課程說明如何在以 SOAP 為基礎的前,產生新的符合 REST 樣式的 API 課程中也會快速介紹 Memorystore 這是 Google Cloud 的全代管 Redis 服務雖然這裡並未詳細說明,但您也可以產生直通式 Proxy ,以便接受 SOAP 酬載並將其傳送至後端服務。
軟硬體需求
- Apigee Edge 帳戶。如果你還沒有 Google 帳戶,可以透過指示註冊 「建立 Apigee 邊緣帳戶。
建立 Proxy
您需要在此處產生 Edge 並放在 SOAP 服務前方的 Proxy。SOAP API Proxy 有兩種類型:
- REST-SOAP-REST Proxy 類型會產生含有翻譯結果且符合 REST 樣式的新 API 附加至 SOAP用戶端將其稱為其他符合 REST 樣式的服務,以傳送查詢 所需參數。Edge 會將此轉譯為 SOAP 酬載 正常運作。
- 直通式 Proxy 代理類型可讓用戶端直接傳入 SOAP 酬載。 如果採用 Edge 管理功能,就能對 SOAP 服務呼叫帶來好處。
Edge
如何使用 Edge UI 代理 SOAP 服務:
- 登入 apigee.com/edge。
- 依序選取「開發」>「開發」API Proxy。
- 按一下「+Proxy」。
- 按一下「SOAP 服務」。
- 在 Proxy 詳細資料頁面中輸入以下內容:
欄位 Descriptoin (文字說明) WSDL 來源 選取:網址
複製以下 WSLD 網址,並貼到「Enter URL」(輸入網址) 欄位中:
https://ws.cdyne.com/delayedstockquote/delayedstockquote.asmx?wsdl
按一下:驗證
Apigee Edge 會取得 WSDL 檔案並加以讀取,以探索作業清單 SOAP 服務支援的通訊協定。
名稱 維持原狀:
delayedstockquote
這是您正在建立的 API Proxy 使用的名稱。
基本路徑 維持原狀: /delayedstockquote
說明 視需要新增說明,例如:Stock quote WSDL API Proxy。 - 點選「下一步」。
- 在「一般政策」頁面的「安全性:授權」下方,選取「通過 (無授權)」。
- 點選「下一步」。
- 在「WSDL 作業」頁面上,選取「REST 到 SOAP 到 REST」。
選取 Proxy 類型後,Edge 會顯示相關作業清單 就會產生 REST API 路徑您可以透過這份清單 請在 WSDL 中的作業中進行選擇 (以 我們要設定的名稱請注意,表格也會顯示 REST 用戶端可用來呼叫後端 SOAP 服務。
請勿變更頁面中的其他所有項目。
- 點選「下一步」。
- 點按「Next」,接受虛擬主機預設值。
- 在「摘要」頁面的「選用部署作業」下方,按一下「測試」,然後按一下「建立及部署」。
Edge 會產生符合 REST 樣式的 API Proxy,然後將其部署至
test
環境。WSDL 會決定服務的 支援的運算、輸入參數等等Edge 會建議要使用的 HTTP 方法 以及各作業的相關資源一般而言,Edge 會將作業轉譯為 GET 要求, 可快取的優勢Edge 也會設定後端目標端點 可能會因為 SOAP 作業而不同。除非您是自訂新的 API Proxy (且您未參與本教學課程),否則 正如火如荼地進行中您可以繼續測試新 API Proxy。
傳統版 Edge (Private Cloud)
如要使用傳統版 Edge UI 代理 SOAP 服務:
- 登入「
http://ms-ip:9000
」(ms-ip 為以下應用程式) Management Server 節點的 IP 位址或 DNS 名稱。 - 選取「API」>API Proxy。
- 按一下「+ API Proxy」。
- 按一下「SOAP 服務」。
- 在 Proxy 詳細資料頁面中輸入以下內容:
欄位 Descriptoin (文字說明) WSDL 選取:範例網址
然後選取:
...delayedstockquote.asmx?WSDL按一下:驗證
Apigee Edge 會取得 WSDL 檔案並加以讀取,以探索作業清單 SOAP 服務支援的通訊協定。
Proxy 名稱 輸入:
delayedstockquote
這是您建立的 Proxy 的名稱。
Proxy 基本路徑和說明 保持原樣。 - 點選「下一步」。
- 在 WSDL 網頁上選取下列項目:
在這個欄位 正確做法 API Proxy 類型 選取:從 REST 到 SOAP 到 REST
選取 Proxy 類型後,Edge 會顯示相關作業清單 就會產生 REST API 路徑,如下所示這份清單可讓您 請在 WSDL 中的作業中進行選擇 (以 我們要設定的名稱請注意,表格也會顯示 REST 用戶端可用來呼叫後端 SOAP 服務。
目前,只要保留第一組作業即可。
通訊埠類型:DelayedStockquoteSap 選取全部三項 WSDL 作業。保留其他設定。
- 點選「下一步」。
- 在「安全性」頁面中,選取「通過 (無)」。
- 點選「下一步」。
- 接受虛擬主機預設值,然後按一下「Next」。
- 在「Build」頁面接受預設值,然後按一下「Build and Deploy」,
要求 Edge 開始產生 Proxy
Edge 會產生符合 REST 樣式的 API Proxy。WSDL 會決定服務的 支援的運算、輸入參數等等Edge 會建議要使用的 HTTP 方法 以及各作業的相關資源一般而言,Edge 會將作業轉譯為 GET 要求, 可快取的優勢Edge 也會設定後端目標端點 可能會因為 SOAP 作業而不同。
除非您是自訂新的 Proxy (且步驟不在本教學課程中),否則 正如火如荼地進行中您可以繼續測試新的 Proxy。
測試 Proxy
如要試用您建立的 Proxy,請開啟命令提示字元並改用 cURL。輸入指令 ,其中:
- ORG 是您建立 Proxy 的 Edge 機構名稱。
- ENV 是部署 Proxy 的環境。
- DOMAIN 對應您使用的 Edge 執行個體。
curl "https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"
舉例來說,如果貴機構為 docfood
,環境為
test
,而您正在使用 Edge Enterprise 雲端,則需執行以下命令:
:
curl "https://docfood-test.apigee.net/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"
如果您在 StockSymbol 查詢參數輸入了 GOOG
,應該會看到
Alphabet Inc. Class C 股票的目前價格例如:
{ "GetQuoteResponse":{ "GetQuoteResult":{ "StockSymbol":"GOOG", "LastTradeAmount":819.55, "LastTradeDateTime":"2017-02-13T14:33:00", "StockChange":5.88, "OpenAmount":816.0, "DayHigh":820.96, "DayLow":815.49, "StockVolume":785064, "PrevCls":813.67, "ChangePercent":"+0.72%", "FiftyTwoWeekRange":"663.28 - 841.95", "EarnPerShare":27.88, "PE":29.4, "CompanyName":"Alphabet Inc.", "QuoteError":false } } }
取得自動產生的 OpenAPI 規格
當您使用「REST 到 SOAP 到 REST」將 SOAP 服務代理時邊緣會自動產生 OpenAPI 規格。您可以使用 OpenAPI 規格,產生 API 的 API 說明文件。
如要取得 OpenAPI 規格,請造訪下列網址:
curl https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/openapi.json
額外課程內容:做法 您是否知道要使用何種資源、動詞和查詢參數?
在測試 API 呼叫中,您在 cURL 呼叫中使用了特定資源和查詢參數 並將要求加入後端 SOAP 服務不過,你該如何自行找出答案?
資源和動詞
建立 Proxy 時,您在 API Proxy 精靈中看到 SOAP 作業 會對應至 API 動詞和資源但要是您沒有把它們記下來,那麼 以便確認 Proxy 建立完成
在 API Proxy 的「Develop」(開發) 分頁中,左側「Navigator」窗格中會顯示
Proxy 端點下的流程清單按一下所需的流程。例如:
使用 GetQuote 流程會是很好的候選鍵。接著在「Code」窗格中查看 XML
,顯示 <Condition> 中流程的資源路徑和動詞元素:
《/quote
》和《GET
》。
查詢參數
選取「Getquote」GetQuote流程後,按一下圖像中的第一個政策
這應該是「擷取變數」政策,用來擷取
應通過:StockSymbol
和 LicenseKey
。(如果您是網站的擁有者
搜尋 SOAP 服務時,會告訴您要將 LicenseKey 傳遞什麼內容)。
擷取的查詢參數會儲存為變數,並由下一個政策使用, 建立 SOAP 訊息。