本文說明您可以在 API 中心入口網站中自定義的設定(預覽)。 API 中心入口網站是一個 Azure 管理的網站,貴組織中的開發人員和其他專案關係人會用來探索 API 中心的 API。
若要設定 API 中心入口網站以進行初始使用和登入,請參閱 設定 API 中心入口網站。
備註
API 中心入口網站目前為預覽狀態。
入口網站設定頁面
在 Azure 入口網站中設定 API 中心入口網站設定。 若要存取設定頁面:
- 在 Azure 入口網站中,瀏覽至您的 API 中心。
- 在 [API 中心入口網站] 底下,選取 [ 設定]。
- 按兩下索引標籤以檢視和自訂設定。
- 選取 [儲存 + 發佈 ] 以套用變更。
這很重要
每次您對設定進行變更時,選取 [ 儲存 + 發佈 ]。 在您發佈之前,您的變更不會顯示在 API 中心入口網站中。
網站設定檔
在 [ 網站配置檔] 索引標籤上,選擇性地提供出現在已發佈入口網站頂端列中的自定義名稱。
API 可見度
在 API 可見度 索引標籤上,管理哪些 API 對於 API 中心入口網站的使用者是可發現和可見的。 可見度設定適用於 API 中心入口網站的所有使用者。
API 中心入口網站會使用 Azure API 中心數據平面 API 來擷取並顯示您 API 中心的 API,預設顯示具有 Azure RBAC 許可權的登入使用者所能存取的所有 API。
若要只顯示特定的 API,請根據內建屬性新增 API 的篩選條件。 例如,選擇只顯示特定類型的 API(例如 REST 或 GraphQL),或根據特定規格格式(例如 OpenAPI)。
匿名存取
在 [ API 可見度 ] 索引標籤上,選擇性地啟用 Azure API 中心數據平面 API 的匿名讀取存取權,這可讓未經驗證的使用者透過直接 API 呼叫來探索 API 清查。 例如,當您 自行裝載 API 中心入口網站時,啟用此設定,讓 API 可供未驗證的使用者探索。
謹慎
啟用匿名存取時,請小心不要在 API 定義或設定中公開敏感性資訊。
語意搜尋
如果在 [語意搜尋 ] 索引標籤上啟用,API 中心入口網站會使用以 API 名稱、描述和選擇性自定義元數據為基礎的 AI 輔助 語意搜尋 來補充基本名稱型 API 搜尋。 語意搜尋僅適用於 標準 方案。
用戶可以使用自然語言查詢來搜尋 API,讓您更輕鬆地根據其意圖尋找 API。 例如,如果開發人員搜尋「我需要 API 進行庫存管理」,則入口網站可以建議相關的 API,即使 API 名稱或描述不包含這些確切字組也一樣。
小提示
使用 Azure API 中心 的免費 方案時,您可以 輕易地升級 至 標準 方案,以啟用完整的服務功能,包括 API 中心入口網站中的語意搜尋。
若要在登入 API 中心入口網站時使用 AI 輔助搜尋,請按下搜尋方塊,選取 [ 使用 AI 搜尋],然後輸入查詢。
自訂中繼資料
在 [ 元數據] 索引標籤上,選擇性地選取您想要在 API 詳細數據和語意搜尋中公開的 自定義元數據 屬性。
啟用測試控制台以存取 API
您可以設定使用者設定,以更細微地授權存取 API 及其 API 中心的特定版本。 例如,將特定 API 版本設定為使用 API 金鑰進行驗證,並建立只允許特定使用者使用這些金鑰進行驗證的存取原則。
存取原則也適用於 API 中心入口網站中 API 的「試用此 API」功能,確保只有具有適當存取原則的入口網站使用者才能針對這些 API 版本使用測試控制台。 深入瞭解授權存取 API
