迁移到新开发人员门户

本文介绍从弃用的旧门户迁移到 API 管理中的新开发人员门户所需的步骤。

重要

旧开发人员门户现在已弃用,并且将仅接收安全更新。 你可以像往常一样继续使用它,直到它在 2023 年 10 月停用,届时将从所有 API 管理服务中将其删除。

API 管理开发人员门户

可用性

重要

此功能在 API 管理的“高级”、“标准”、“基本”和“开发人员”层中可用 。

有关 v2 层(预览版)中的功能可用性,请参阅 v2 层概述

新开发人员门户中的改进

新的开发人员门户解决了弃用门户的许多限制。 它具有 视觉拖放编辑器,用于编辑内容,以及供设计人员设置网站的样式的专用面板。 页面、自定义项和配置将保存为 API 管理服务中的 Azure 资源管理器资源,这使你可以 自动执行门户部署。 最后,门户的代码库是开源的,因此 可以使用自定义功能来扩展它

如何迁移到新的开发人员门户

新的开发人员门户与弃用的门户不兼容,并且无法自动迁移。 需要手动重新创建内容(页面、文本、媒体文件)并自定义新门户的外观。 具体步骤因门户的自定义和复杂性而异。 有关指导,请参阅开发人员门户教程 。 其余配置(如 API、产品、用户、标识提供者列表)会自动在两个门户中共享。

重要

如果之前已启动新的开发人员门户,但尚未进行任何更改,请重置默认内容以将其更新到最新版本。

从弃用的门户迁移时,请记住以下更改:

  • 如果通过自定义域公开开发人员门户,向新的开发人员门户分配域。 使用 Azure 门户中下拉列表中的 开发人员门户 选项。

  • 在 API 上应用 CORS 策略 以启用交互式测试控制台。

  • 如果通过注入自定义 CSS 来设置门户的样式,则需要 使用内置设计面板来复制该样式。 新门户中不允许使用 CSS 注入。

  • 只能在新门户 自托管版本中注入自定义 JavaScript。

  • 如果 API 管理位于虚拟网络中,并通过应用程序网关向 Internet 公开,请参阅本文档 获取精确的配置步骤。 你需要:

    • 启用与 API 管理管理终结点的连接。
    • 启用与新门户终结点的连接。
    • 禁用所选的 Web 应用程序防火墙规则。
  • 如果更改了默认电子邮件通知模板以包含显式定义的已弃用门户 URL,请将其更改为使用门户 URL 参数或指向新的门户 URL。 如果模板改用内置门户 URL 参数,则无需更改。

  • 在新开发人员门户中,问题应用程序 不受支持。

  • 新开发人员门户中不支持与 Facebook、Microsoft、Twitter 和 Google 作为标识提供者的直接集成。 可以通过 Azure AD B2C 与这些提供程序集成。

  • 如果使用委派,请更改应用程序中的返回 URL,并使用 获取共享访问令牌 API 终结点,而不是 生成 SSO URL 终结点。

  • 如果您使用 Microsoft Entra ID 作为标识提供者:

    • 将应用程序中的返回 URL 更改为指向新的开发人员门户域。
    • 将应用程序中返回 URL 的后缀从 /signin-aad 修改为 /signin
  • 如果使用 Azure AD B2C 作为标识提供者:

    • 将应用程序中的返回 URL 更改为指向新的开发人员门户域。
    • 将应用程序中返回 URL 的后缀从 /signin-aad 修改为 /signin
    • 在应用程序声明中包括 名字姓氏用户对象 ID
  • 如果在交互式测试控制台中使用 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 的隐式授予流。

后续步骤

详细了解开发人员门户: