共用方式為

移轉至新的開發人員入口網站

  • 發行項

本文說明從已淘汰的舊版入口網站移轉至 API 管理中新開發人員入口網站所需的步驟。

這很重要

舊版開發人員入口網站現在已被取代，而且只會收到安全性更新。 您可以照舊繼續使用，直到其在 2023 年 10 月淘汰，屆時便會將其從所有 API 管理服務中移除。

API 管理開發人員入口網站

可用性

這很重要

這項功能可用於 API 管理的進階、標準、基本與開發人員層。

如需 v2 層的功能可用性（預覽），請參閱 v2 層概觀。

新開發人員入口網站中的改善

新的開發人員入口網站可解決已淘汰入口網站的許多限制。 它提供 可視化拖放編輯器來編輯內容 ，以及設計工具用來設定網站樣式的專用面板。 頁面、自定義和設定會儲存為 API 管理服務中的 Azure Resource Manager 資源，可讓您 將入口網站部署自動化。 最後，入口網站的程式代碼基底是開放原始碼，因此 您可以使用自定義功能加以擴充。

如何移轉至新的開發人員入口網站

新的開發人員入口網站與已淘汰的入口網站不相容，因此無法進行自動化移轉。 您必須手動重新建立內容 (頁面、文字、媒體檔案) 並自訂新入口網站的外觀。 精確步驟會根據入口網站的自定義和複雜度而有所不同。 如需指引 ，請參閱開發人員入口網站教學 課程。 其餘組態，例如 API、產品、使用者、身分識別提供者的清單，會自動在兩個入口網站之間共用。

這很重要

如果您之前已啟動新的開發人員入口網站，但尚未進行任何變更，請將預設內容重設為最新版本。

當您從已淘汰的入口網站移轉時，請記住下列變更：

  • 如果您透過自定義網域公開開發人員入口網站， 請將網域指派 給新的開發人員入口網站。 使用 Azure 入口網站中下拉式清單中的 [開發人員入口網站 ] 選項。

  • 在您的 API 上套用 CORS 原則，以啟用互動式測試控制台。

  • 如果您插入自定義 CSS 來設定入口網站的樣式，則必須 使用內建設計面板來復寫樣式。 新入口網站中不允許 CSS 插入。

  • 您只能在新入口網站的 自我託管版本中插入自定義 JavaScript。

  • 如果您的 API 管理位於虛擬網路中，並透過應用程式閘道公開至因特網， 請參閱本檔文章 以取得精確的設定步驟。 您需要：

    • 啟用對 API 管理管理端點的連線。
    • 啟用與新入口網站端點的連線。
    • 停用選取的 Web 應用程式防火牆規則。

  • 如果您變更預設電子郵件通知範本以包含明確定義的已取代入口網站 URL，請將其變更為使用入口網站 URL 參數或指向新的入口網站 URL。 如果範本改為使用內建入口網站 URL 參數，則不需要變更。

  • 新的開發人員入口網站不支援問題和應用程式。

  • 新開發人員入口網站不支援與Facebook、Microsoft、Twitter和Google作為身分識別提供者的直接整合。 您可以透過 Azure AD B2C 與這些提供者整合。

  • 如果您使用委派，請變更應用程式中的傳回 URL，並使用 取得共用存取令牌 API 端點 ，而不是 產生 SSO URL 端點。

  • 如果您使用 Microsoft Entra ID 作為識別提供者：

    • 將應用程式中的傳回 URL 變更為指向新的開發人員入口網站網域。
    • 將應用程式中 /signin-aad 傳回 URL 的後綴從 修改為 /signin。

  • 如果您使用 Azure AD B2C 作為識別提供者：

    • 將應用程式中的傳回 URL 變更為指向新的開發人員入口網站網域。
    • 將應用程式中 /signin-aad 傳回 URL 的後綴從 修改為 /signin。
    • 在應用程式宣告中包含 指定名稱、 姓氏和 使用者的物件識別碼 。

  • 如果您在互動式測試控制台中使用 OAuth 2.0，請將應用程式中的傳回 URL 變更為指向新的開發人員入口網站網域，並修改後綴：

    • 從 /docs/services/[serverName]/console/oauth2/authorizationcode/callback 到 /signin-oauth/code/callback/[serverName] 的授權碼授予流程。
    • 從 /docs/services/[serverName]/console/oauth2/implicit/callback 到 /signin-oauth/implicit/callback 的隱式授權流程。

  • 如果您在互動式測試控制台中使用 OpenID Connect，請將應用程式中的傳回 URL 變更為指向新的開發人員入口網站網域，並修改後綴：

    • 從 /docs/services/[serverName]/console/openidconnect/authorizationcode/callback 到 /signin-oauth/code/callback/[serverName] 的授權碼授與流程。
    • 從 /docs/services/[serverName]/console/openidconnect/implicit/callback 到 /signin-oauth/implicit/callback 用於隱式授權流程。

後續步驟

深入了解開發人員入口網站：