共用方式為

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

  • 發行項

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

重要

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

API Management developer portal

可用性

重要

這項功能可用於 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識別碼作為識別提供者：

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

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

    • 變更應用程式中的傳回 URL 以指向新的開發人員入口網站網域。
    • 將應用程式中傳回 URL 的尾碼從 /signin-aad 修改為 /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。

後續步驟

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