Microsoft Azure API 管理功能簡介 (上)

 

Microsoft API 管理架構

 


 

 在眾多平台盛行的情況下,商業服務都紛紛地提出 API 來迎合這些不同的平台,Azure 上提供了一個新的 API 管理預覽功能,提供使用者整合外部的、partner、以及內部的 API,
並且提供了一個很好的管理者平台以及開發者的入口網站。讓您的組織可以更快速地提供穩定的服務。

 本文章將包括以下內容:

1)建立 API 管理服務

2)管理主控台功能介紹

3)開發人員入口網站介紹

 

建立 API 管理服務:

1)在 Azure portal 中的左下方點選 「建立」,並點選 「應用程式服務」、 「建立」來建立一個新的 API 管理服務。

 

 

2)您可以輸入您欲設定的 URL ,並且可以依照您的使用量來選擇定價方案。

詳細的定價方案可以參考此網站

 

 

3)接著請輸入您的組織名稱以及管理員的電子郵件信箱,按下「確認」,即建立完成。

 

 

管理主控台

在服務提供者擴大他們的業務,創造新的管道、尋找新的客戶的同時。API 管理提供的核心能力,以確保成功的 API 程式通過開發者的參與、商業洞察力、 分析、安全和保護。

 

  • 點選進入 API 管理服務當中,可在開始使用頁面選取「管理主控台」進入到 API 管理頁面。另外,開發者也可以點選「開發人員入口網站」來使用客製化的 API 操作介面。

 

 

 

Dashboard

  • 在 Dashboard 頁面可以看到貴組織中所有的 API 使用紀錄、產品的訂閱狀態以及應用程式的發行狀態。

 

 

 

API

  • 在 API 頁面可以看到貴組織所有加入的 API,您可以按下「ADD API」新增一個 API 服務、點選項目進入設定,或是按下 「DELETE」將該 API 刪除。

 

 

 

在設定頁面中,您也可以輸入功能以及標題的描述。

 

 

在 Operations 的頁面,您可以設定呼叫此 API 的操作方法;設定此操作的 HTTP 動詞;同時也可以改寫呼叫的 URL。

URL template:

顯示您想要呼叫的方式,並在 “{ }” 內放入您的參數名稱。

Rewrite URL template:

        顯示原本要被改寫的 URL。 “{ }” 中的參數名稱要和 URL template 中的一樣。

Display name 和 Description 則是顯示的 API 名稱以及內容描述。

 

 

Products

  • Product 是 API 被包裝給開發者的一種形式,一個 Product 底下包裝了許多同型態的 API,而開發者可以訂閱某個特定 Product ,使用該 Product 底下的 API 來進行開發。

 

 

 

在這個 Product 內的 summary 可以新增和編輯 API ,並且可以設定將此 API 發行。 

 

每個 Product 底下都可以設定開發者的權限,限定開發者的檢視權限。

 

 

 

同時也可以看到這個 Product 的訂閱者。

 

 

 

Policy

  • 在 Policies 中可以設定該 Product 內不同的 API,並且從右側的 Policy statement 加入配置的模板。
  • 這些模板的內容,可以參考完整的 模板配置清單

 

Analytics

  • Analytics 提供了 API 的用量分析,並且提供了各個產品、API、開發者的使用狀況排行分析。
  • 用量分析包含了呼叫次數、回覆時間、頻寬以及錯誤。

 

 

使用量分析可分國家別和顏色來呈現

 

 

Users

  • 使用者管理的功能可讓您新增或邀請使用者進入專案當中,管理者也可以利用此頁面來管理使用者權限。

 

 

Groups

  • 在 Groups 內可以新增開發者群體,把開發者依照類別或專案內容歸類在一起。

 

 

Notification

Notification 功能提供了管理者在處理開發者的訂閱時,可以更快速地回覆和處理需求。此功能提供了 email 的回覆模板以及處理訂閱需求的管理回覆信箱。

 

Applications

這項功能可讓開發者在開發者平台上傳應用程式;而管理者可以在後台介面審核開發者上傳的應用程式。

 

System Settings

在系統設定內可以讓您透過 API Management REST API 來執行在開發者和管理者的各項操作,包括配置貴組織的 API、存取 API 使用量分析資料等。

 

 

API 管理的開發者入口網站功能將在下一篇文章中介紹:

  Microsoft Azure API 管理預覽功能簡介 (下)

 

 

參考資料

1) Azure API 管理

https://azure.microsoft.com/zh-tw/services/api-management/

 

2) Azure API 管理概念

https://azure.microsoft.com/zh-tw/documentation/articles/api-management-key-concepts/#groups