迁移到新开发人员门户

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

可用性

新开发人员门户中的改进

新的开发人员门户解决了已弃用门户的许多限制。 它具有用于编辑内容的可视化拖放编辑器和设计人员用于设置网站样式的专用面板。 页面、自定义和配置将保存为 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”终结点 。

• 如果你使用 Azure AD 作为标识提供者：

  • 更改应用程序中的返回 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。

后续步骤

详细了解开发人员门户：

• Azure API 管理开发人员门户概述
• 访问和自定义开发人员门户