全部產品
Search
文件中心

API Gateway:事件匯流排

更新時間:Jul 13, 2024

本文將快速引導您如何在API Gateway中,發布後端服務為事件匯流排類型的API,並如何使用“阿里雲APP“認證中的AppCode進行調用。

概述

您需要依次完成以下步驟:

  • 建立後端服務

  • 建立API分組

  • 定義API

  • 建立應用和API授權

  • 調試API

  • 調用API

前提條件

您需要先開通事件匯流排,並建立自己的自訂事件匯流排,詳情可以參考管理自訂事件匯流排

建立後端服務

  1. 登入API Gateway控制台,在左側導覽列選擇API管理-後端服務

  2. 在介面的右上方選擇建立後端服務,在彈出來的對話方塊中填入後端服務名稱,後端類型選擇“事件匯流排EventBridge”,單擊確定建立後端服務;

  3. 在後端服務列表中找到您剛建立的後端服務,在後邊的操作欄中選擇配置及關聯的API

  4. 選擇“線上”環境,在介面的右側選擇建立進入後端服務線上上環境的配置介面,只有在環境上建立了後端服務,之後的步驟中建立的API才發行就緒到相應的環境;

  5. 在定義後端服務介面,可以選擇在事件匯流排控制台建立的事件匯流排。

說明

當事件匯流排和API Gateway在同一地區中時(此例中均為杭州),在發起API調用時,網關將通過內網將事件推送到事件匯流排中。

建立API分組

  1. API分組是API的嵌入式管理單元,因此需要先建立API分組,然後在分組下建立API。

在API Gateway控制台左側導覽列選擇API管理-分組管理,在介面的右上方單擊建立分組;在彈窗頁面,選擇分組執行個體,輸入分組名稱,選擇執行個體。注意API Gateway的分組需要和事件匯流排處於同一Region

分組列表查看建立好的分組,單擊名稱可以進入到詳情頁,進行綁定網域名稱、修改基本資料、切換執行個體類型等動作。

API分組會自動建立公網次層網域,此次層網域僅供調試使用,如果直接存取此網域名稱,每天有1000次的限制(海外Region及中國香港限制100次/天)。因此建議您在使用時為分組綁定您的獨立網域名稱後使用。在本樣本中使用此網域名稱進行測試。

建立API

在API Gateway控制台左側導覽列選擇API管理-API列表,在介面的右上方單擊建立API

  1. API基本資料

本環節是定義了API基本資料,包括API分組、API名稱、安全認證方式、API類型、和描述等。選擇剛剛建立的分組,寫入對應配置,安全認證選擇APPcode(header&Query)認證

  1. 定義API請求

本環節是定義client端(如瀏覽器、手機APP或其他的業務系統)如何請求您的API,需要確定的內容包括請求類型、協議、請求Path、HTTP Method、入參請求模式、和入參定義。在本例中,入參請求方式選擇入參透傳,表示發送過來的參數API Gateway不做處理,直接透傳給事件匯流排。

  1. 定義API後端服務資訊

本環節是定於API Gateway收到client端的請求後,進行何種參數映射、處理,以及串連哪個後端地址。本例中的後端服務類型選擇使用已有的後端服務-事件匯流排,選擇之前建立的後端服務,進行下一步。

說明

後端服務為事件匯流排的API當前只支援使用後端服務的方式,不支援自訂的方式;

  1. 定義返回結果

本環節用於API協助文檔的自助產生,協助API使用者更好理解。可以設定返回結果樣本和失敗返回結果樣本。本例中不涉及到這部分,因此可以單擊儲存按鈕。

  1. 發布API

對API進行過任何的配置,都需要發布到對應的環境中才能夠生效。本例中在建立後端服務的時候,只線上上環境進行了後端服務配置,因此這裡只發行就緒到線上環境,如果您需要發布到其他環境,需要在您剛建立的後端服務的其他環境配置後端服務定義。單擊發布,按照控制台頁面的提示,把此API發布到“線上“環境。

建立應用和API授權

應用(APP)是您調用API服務時的身份。在本例建立API的時候,認證方式選擇的是“阿里雲APP認證“,因此在API發布後,還需要建立APP,並將APP和API的對應關係建立好,才能夠正常訪問。

  1. 建立應用

在API Gateway控制台左側導覽列選擇API管理-應用管理,建立一個APP。可以看到阿里雲APP下有兩種認證方式,AppKey和AppCode。本例中我們選擇使用APPCode的方式進行簡單認證。關於阿里雲APP的更多描述可見此文檔授權管理

  1. 對API進行授權

API列表,找剛建立好的API,在操作項中,單擊授權。注意環境需要選擇已經進行了發布的環境,如本例中的“線上“。搜尋之前建立的應用,單擊添加;單擊確定,提示授權成功,即成功授權。

調試API

API Gateway提供了線上調試的功能,因此一般建議在API Gateway上完成API配置之後,可以先通過此功能確認API是否配置成功,然後再通過client端進行調用。

API列表,單擊前面步驟中新增的API,進入詳情頁,單擊調試API進入如下頁面。如果您定義了API的入參,在調試API頁面中也可以輸出不同的參數查看API的執行情況。

在調試API中,注意認證方式選擇已經授權的APP,並且stage選擇此APP授權好的環境,如果選擇錯誤的stage,可能會造成API調試失敗。本例中選擇RELEASE(線上)。

調試成功後,您可以根據返回的事件ID,到您的事件匯流排中根據事件ID查詢事件的詳情。

調用API

通過上述步驟,已經建立API、建立APP、建立了授權關係,調試API完成,並將API發布到線上環境,本階段使用APPCode的認證方式來調用發布好的API。

可以參考使用簡單認證(AppCode)方式調用API瞭解更多。