Azure API Management （2）體驗開發者門戶,微軟azure雲搭建服務器

Azure API Management （2）體驗開發者門戶,微軟azure雲搭建服務器

Azure API Management （2）體驗開發者門戶

於書振

原國家電網公司特高壓電力專家,原中國聯通5G創新中心高級解決方案經理，國內較早實施5G智慧港口和邊緣計算的新基建踐行者。十餘年特高壓/智慧城市/5G/雲計算/物聯網等領域的工作經驗，Microsoft Certified Azure Solutions Architect Expert，Microsoft Certified Azure IoT Developer Specialty，Microsoft Certified Trainer，2020年被評爲微軟MVP。他熱心社區奉獻，運營公衆號“雲計算實戰”分享接地氣的Azure IoT和AI實戰內容，同時爲每一個實戰內容製作了15分鐘左右的視頻講解發布在B站和其博客https://www.51azure.cloud

幾個重要的概念

1.API

導入或者在Azure Portal上創建的一組API或者多組API，例如導入了一組訂單相關API和一組庫存相關API；

2.產品

產品包含至少一組API，通常產品把多組API打包在一起，形成一個包含多種功能的一個集合，例如：定義了一個產品“進銷存”，該產品包含一組訂單相關的API和一組庫存相關的API；

3.用戶

這裏的用戶通常指使用API Management的人員，其中包含要調用你發佈的API的開發人員。

4.組

組指的用戶組，一個組可以包含多個成員，也就是包含多個“用戶”，系統內置了“Administrator”，“Developer”，“Guests”三個組。

5.訂閱

訂閱決定了哪個”用戶“可以調用哪個“API”或者哪個“產品”。

訂閱是綁定到“用戶”上的，訂閱能控制某個API或某個產品。

6.開發人員門戶（developer portal）

通常情況下，開發人員門戶是提供給“用戶”，也就是要調用你API的人員使用的一個門戶網站。

用戶可以在這個網站維護自己的賬號信息，查看自己的訂閱信息，查看API文檔/在線測試API。

默認情況下，他的url後半部分爲：developer.azureapi.net;

可以在開發人員門戶上提交註冊信息，根據配置，可能需要審覈或自動完成審覈，然後便成了“用戶”，用戶可以根據API及產品是否需要訂閱或者訂閱權限調用對應的API。

在開發人員門戶上自主註冊的用戶，默認自動分配到“Developer”組中。

通常整體的使用流程是：

管理員（也就是API的提供者）從Azure Portal導入後端API

管理員在Azure Portal對導入的API進行設置，比如增加流控等功能

管理員在Azure Portal創建一個包含一組或多組API的產品併發布

管理員在Azure Portal發佈開發人員門戶（通常該步驟僅執行一次）

用戶從開發人員門戶自主註冊或者從管理員從Azure Portal上註冊用戶

管理員從Azure門戶上爲用戶創建訂閱

用戶在開發人員門戶學習如何調用API並做測試

用戶在自己的業務系統中調用API

01

管理員（也就是API的提供者）從Azure Portal導入後端API

上一講分享的內容中，我們已經完成了API的導入，本文不再贅述，如果您尚未完成API導入，請參照《Azure API Management（1）Create APIM And Add First API,創建Azure APIM並添加後端API》

02

管理員在Azure Portal對導入的API進行設置，比如增加流控等功能

流控等功能我們在以後的章節中介紹，本文可以跳過這個步驟。

03

管理員在Azure Portal創建一個包含一組或多組API的產品併發布

注意：

3處的狀態爲“未發佈”，未發佈的產品不會在開發者門戶中看到。稍後需要執行”發佈產品“操作後，纔會出現在開發者門戶中；

3處的“需要訂閱”如果不勾選，則用戶在開發者門戶中無需訂閱即可進行該產品關聯api的調用；

5處的API可以選擇多個或者一個；

產品創建完成後，默認的訪問控制組在“Administrator”中，如果需要被“開發者麼戶”中創建的用戶訪問，則需要添加“developers”組，因爲從門戶自主註冊的用戶，默認爲“developers”組：

發佈產品，只有發佈後的產品，纔會顯示在開發人員門戶中：

04

管理員在Azure Portal發佈開發人員門戶（通常該步驟僅執行一次）

注意：如果不開啓cors，則用戶在開發人員門戶上無法測試api調用。

05

用戶從開發人員門戶自主註冊或者從管理員從Azure Portal上註冊用戶

點擊開發人員門戶可以進入開發人員門戶，此時是管理員默認登錄對門戶的編輯模式，需要切換瀏覽器，才能以新的用戶session訪問開發人員門戶：

點擊右上角註冊：

默認註冊使用郵箱和密碼方式：

在郵箱中查收驗證郵件並驗證郵箱：

登錄開發人員門戶：

登錄成功，看到如下頁面：

查看profile：

注意，此時新用戶並沒有任何subscription，稍後我們將在Azure Portal爲用戶添加訂閱。

06

管理員從Azure門戶上爲用戶創建訂閱

在Azure Poral中查看剛註冊成功的用戶：

用戶即開發人員，也就是要使用你api的人員；

從developer portal自主創建的用戶，默認在“developer”組中。

爲用戶創建分配訂閱：

在用戶頁面點擊訂閱，添加訂閱：

新建訂閱可以產品級別或者API級別的訂閱，本例選擇產品級別的訂閱，並選擇剛纔發佈的產品。

在下拉列表中選擇剛纔發佈的產品，然後創建訂閱。

用戶可以在開發人員門戶中查看管理員爲你分配的訂閱：

在developer portal中查看分配的訂閱：

07

用戶在開發人員門戶學習如何調用API並做測試

在開發人員portal中進行api測試：

subscription key在創建時是有作用範圍的，本例中，我們將subscription key的權限綁定到“newproduct”上，因此，該key在其他product或者其爲包含在“newproduct”裏的api，都是無效的：

如下圖，我們用subscription key對echo api進行訪問，結果爲401：

08

用戶在自己的業務系統中調用API

針對多語言的示例代碼，將代碼集成到自己的業務系統中，完成API調用開發。

微軟最有價值專家是微軟公司授予第三方技術專業人士的一個全球獎項。27年來，世界各地的技術社區領導者，因其在線上和線下的技術社區中分享專業知識和經驗而獲得此獎項。

MVP是經過嚴格挑選的專家團隊，他們代表着技術最精湛且最具智慧的人，是對社區投入極大的熱情並樂於助人的專家。MVP致力於通過演講、論壇問答、創建網站、撰寫博客、分享視頻、開源項目、組織會議等方式來幫助他人，並最大程度地幫助微軟技術社區用戶使用Microsoft技術。

更多詳情請登錄官方網站：

https://mvp.microsoft.com/zhcn

特別聲明：以上文章內容僅代表作者本人觀點，不代表ESG跨境電商觀點或立場。如有關於作品內容、版權或其它問題請於作品發表後的30日內與ESG跨境電商聯繫。