本文說明如何設定 API 中心入口網站 (預覽),這是一個 Azure 管理的網站,讓貴組織中的開發人員和其他項目關係人用來探索 API 中心內的 API。 登入的使用者可以瀏覽和篩選 API,並檢視 API 詳細數據,例如 API 定義和檔。 使用者對 API 資訊的存取是以Microsoft Entra ID 和 Azure 角色型訪問控制為基礎。
備註
API 中心入口網站目前為預覽狀態。
小提示
Azure API 管理和 Azure API 中心都為開發人員提供 API 入口網站體驗。 比較入口網站
先決條件
Azure 訂用帳戶中的 API 中心。 如果您尚未建立,請參閱快速入門:建立您的 API 中心。
在與 Azure 訂用帳戶相關聯的 Microsoft Entra 租用戶中建立應用程式註冊的權限,以及授與 API 中心資料存取權的權限。
建立 Microsoft Entra 應用程式註冊
請先在Microsoft Entra ID 租用戶中設定應用程式註冊。 應用程式註冊可讓 API 中心入口網站代表登入的使用者,從您的 API 中心存取數據。
API 中心可以自動設定應用程式註冊,或者您可以手動建立應用程式註冊。
自動設定應用程式註冊
若要自動設定應用程式註冊,請遵循下列步驟:
- 在 Azure 入口網站中,瀏覽至您的 API 中心。
- 在左側功能表中,選取 [API 中心入口網站>設定]。
- 在 [ 識別提供者] 索引 標籤上,選取 [ 啟動設定]。
- 在 [ 快速設定] 索引標籤上,選取 [ 儲存 + 發佈]。
如果您需要稍後存取應用程式註冊,您可以在入口網站的 [ 應用程式註冊] 底下找到它。 應用程式會以下列格式命名:<api-center-name-apic-aad>。
手動設定應用程式註冊
如果您想要手動建立應用程式註冊,請遵循下列步驟:
在 Azure 入口網站中,瀏覽至 Microsoft Entra ID>管理>應用程式註冊。
選取 + 新增註冊。
在 [註冊應用程式] 頁面上設定值,如下所示:
- 將 [名稱 ] 設定為有意義的名稱,例如 api-center-portal
- 在 支援的使用者帳戶類型 下,選取 僅限此組織目錄中的使用者帳戶(<目錄名稱> - 單一租戶)。
- 在 [重新導向 URI] 中,選取 [單頁應用程式][SPA], 然後設定 URI。
以下列形式輸入 API 中心入口網站部署的 URI:
https://<service-name>.portal.<location>.azure-apicenter.ms。 將<service name>和<location>替換為您的 API 中心名稱及其部署位置,例如:https://myapicenter.portal.eastus.azure-apicenter.ms。 - 選取 註冊。
設定 VS Code 延伸模組的其他重新導向 URI
在適用於 API 中心的 Visual Studio Code 擴充功能中啟用 API 中心入口網站檢視時,也會在應用程式註冊中設定下列重新導向 URI:
在 Azure 入口網站中,瀏覽至您的應用程式註冊。
在 [ 管理>驗證] 頁面上,選取 [新增平臺] ,然後選取 [ 行動和桌面應用程式]。
設定下列三個自訂重新導向 URI:
https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>將
<application-client-id>替換為此應用程式的客戶端應用程式 ID。 您可以在應用程式註冊的 [概 觀 ] 頁面上找到此值。
設定和發佈 API 中心入口網站
建立 API 中心入口網站應用程式註冊之後,您可以 自訂設定 併發佈 API 中心入口網站。 在 Azure 入口網站中完成下列步驟。
在 Azure 入口網站中,瀏覽至您的 API 中心。
在左側功能表中的 [API 中心入口網站] 底下,選取 [ 設定]。
如果您手動設定應用程式註冊,請在 [ 識別提供者 ] 索引標籤上,選取 [ 啟動設定]。 如果您使用快速設定,此步驟已經完成,而且您可以繼續在其他索引標籤上進行設定。
- 在 [ 手動] 索引標籤的 [ 用戶端識別符] 中,輸入您在上一節中建立之應用程式註冊的應用程式 (client) 識別碼 。
- 確認 [ 重新導向 URI ] 是您在應用程式註冊中設定的值。
- 選取 [儲存 + 發佈]。
在其餘索引標籤上,選擇性地自定義 API 中心入口網站的設定。 如需設定的相關信息,請參閱 自定義您的 API 中心入口網站。
選取 [儲存 + 發佈]。
存取入口網站
發佈之後,您可以在瀏覽器中存取 API 中心入口網站。
- 在入口網站的 [ 設定 ] 頁面上,選取 [ 檢視 API 中心入口網站 ] 以在新索引卷標中開啟入口網站。
- 或者,在瀏覽器中輸入下列 URL,將
<service-name>和<location>分別替換為您的 API 中心的名稱及其部署位置。
https://<service-name>.portal.<location>.azure-apicenter.ms
根據預設,入口網站首頁可公開連線,但需要登入才能存取 API。 如需設定使用者存取入口網站的詳細資訊,請參閱以 Microsoft Entra 的使用者和群組啟用入口網站登入。
啟用透過 Microsoft Entra 使用者和群組登入入口網站
若要啟用登入 API 中心入口網站以存取 API,請將 Azure API 中心數據讀取者 角色指派給您組織中的使用者或群組,範圍限定於您的 API 中心。
這很重要
根據預設,您和其他 API 中心的系統管理員必須登入,才能在 API 中心入口網站中存取 API。 請務必將 Azure API 中心數據讀取者 角色指派給自己和其他系統管理員。
如需將角色指派給使用者和群組的詳細必要條件和步驟,請參閱 使用 Azure 入口網站指派 Azure 角色。 簡短步驟如下:
- 在 Azure 入口網站中,瀏覽至您的 API 中心。
- 在左側功能表中,選取 [ 訪問控制][IAM]>[+ 新增角色指派]。
- 在 [ 新增角色指派 ] 窗格中,設定值,如下所示:
- 在 角色 頁面上,搜尋並選取 Azure API Center 資料讀取程式。 選取 下一步。
- 在 [ 成員] 頁面上的 [ 指派存取權] 中,選取 [ 使用者、群組或服務主體>] + [選取成員]。
- 在 [ 選取成員] 頁面上,搜尋並選取要指派角色的使用者或群組。 按一下 [選取],然後按 [下一步]。
- 檢閱角色指派,然後選取 [檢閱 + 指派]。
備註
若要簡化新使用者的存取設定,建議您將角色指派給 Microsoft Entra 群組,並設定動態群組成員資格規則。 若要深入瞭解,請參閱 在 Microsoft Entra ID 中建立或更新動態群組。
設定入口網站的存取權之後,設定的使用者就可以登入入口網站,並在您的 API 中心檢視 API。
備註
系統會提示第一個登入入口網站的使用者同意 API 中心入口網站應用程式註冊所要求的許可權。 之後,系統不會提示其他已設定的使用者同意。
API 中心入口網站中的 API 探索和取用
API 中心入口網站支援並簡化在組織內使用和建立 API 的開發人員工作。 登入的使用者可以:
依名稱或使用 AI 輔助語意搜尋來搜尋 API
依類型或生命週期階段篩選 API
檢視 API 詳細資料和定義 ,包括端點、方法、參數和回應格式
將 API 定義下載 到本機電腦,或在 Visual Studio Code 中加以開啟
試用 支援 API 金鑰驗證或 OAuth 2.0 授權的 API
API 管理和 API 中心入口網站
Azure API 管理和 Azure API中心服務都提供入口網站,讓開發人員探索及取用 API:
- API 管理開發人員入口網站可讓用戶尋找受控 API、瞭解如何使用它們、要求存取權,以及測試它們。
- API 中心入口網站 (預覽) 是多閘道入口網站,使用者可以探索及篩選組織的完整 API 清查。
雖然兩個入口網站共用一些功能,但它們也有不同的差異。 下表比較目前的功能,以協助判斷要使用的入口網站。 有些組織可能偏好一個入口網站,有些則可能需要兩者。
| 特徵 / 功能 | API 管理開發人員入口網站 | API 中心入口網站 (預覽) |
|---|---|---|
| 搜尋和篩選 API 清單 | 僅限 API 管理執行個體 | 所有 API1 |
| 檢視 API 詳細資料和定義 | ✔️ | ✔️ |
| 檢視 API 文件 | ✔️ | ✔️ |
| 品牌客製化 | ✔️ | 只有名稱 |
| 與 Microsoft Entra ID 整合 | ✔️ | ✔️ |
| 新增自訂小工具 | ✔️ | ❌ |
| 使用 WordPress 自定義 | ✔️ | ❌ |
| 在測試控制台中測試 API | ✔️ | ✔️ |
| 訂閱 API(應用程式介面) | ✔️ | ❌ |
| 檢視 API 使用量分析 | ✔️ | ❌ |
1 API 中心入口網站可以包含您組織中的所有 API,包括 Azure API 管理和其他平臺中管理的 API,以及開發中的非受控 API 和 API。