将 Drupal 7 门户迁移到集成式门户

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

本部分将指导您规划和执行将 Drupal 7 门户资源迁移到集成门户的操作。

第 1 步:创建集成式门户

在迁移 Drupal 7 门户资源之前,您必须创建一个集成式门户。

如需创建集成式门户,请执行以下操作:

  1. 请确保您拥有适当的门户角色来管理集成式门户。
  2. 创建集成式门户

创建集成式门户时,系统会提供一组起始页面,供您作为跳转点。 起始页面包含演示内容,有助于您在将文本和图片替换为自己独有的内容时为自己开发门户提供灵感。 如需了解详情,请参阅关于示例门户

第 2 步:构建集成式门户

按照构建门户的步骤中的说明构建集成式门户。

您至少需要执行下表中列出的步骤。

步骤 说明
开发门户内容 例如概念信息和入门信息。

您可以选择创建页面,然后直接从现有 Drupal 7 门户复制并粘贴页面内容。

设置导航 创建匹配现有结构所需的导航栏。
自定义主题 至少要自定义以下组件,使其符合您的品牌要求:
添加自定义脚本 根据需要向门户添加自定义 JavaScript 代码。
配置电子邮件 配置 SMTP 服务器以及电子邮件通知的内容。

注意:目前,Apigee Hybrid 集成门户无法使用电子邮件通知配置。

管理默认的公开范围 管理特定资源的默认公开范围。
配置内容安全政策 如有需要,您可以为门户中的所有页面配置内容安全政策 (CSP),以防范跨站脚本攻击 (XSS) 和其他代码注入攻击。

注意:此功能目前不适用于 Apigee Hybrid 集成门户。

第 3 步:配置身份提供方

根据下表中所列的身份验证类型,在集成式门户上配置身份提供方。

身份验证 说明
内置身份提供方(用户名/密码) 在集成式门户上配置内置的身份提供方
使用 SAML 进行单点登录 (SSO) 在集成式门户上配置 SAML 身份提供方(Beta 版)

注意

开发者登录门户后,您可以按照管理开发者账号中的说明管理他们的账号。

第 4 步:使用受众群体控制对资源的访问权限

如果您使用 Drupal 7 中的角色来控制对一组资源的访问权限(例如 API 文档或 API 产品的 API 密钥创建),您可以使用集成门户上的受众群体来实现相同的功能。

具体来说,您可以使用受众群体来控制对集成式门户上以下资源的访问权限:

  • 门户中的页面
  • 已发布的 API 产品

如需添加受众群体并管理个别用户和开发者团队的分配关系,请参阅管理受众群体。当新用户创建帐号并登录您的门户时,您需要根据需要将其分配给一个或多个受众群体,如管理受众群体的分配中所述。

为了简化迁移,您可以考虑以下提示:

  • 以受众群体将被替换的 Drupal 角色命名受众群体。
  • 通过开发者团队管理受众群体成员资格。开发者可创建团队来分担应用责任并管理团队成员资格。

第 5 步:发布您的 API

如需在集成门户上使用 SmartDocs 发布 API 并自动生成 API 参考文档,您需要访问与该 API 关联的 OpenAPI 规范

尽管您可能已使用 OpenAPI 规范在 Drupal 7 中自动生成 SmartDocs,但内容最终会使用内部格式进行存储,且与原始 OpenAPI 规范没有任何关联。使用 Apigee Edge 的 API 团队通常会将 OpenAPI 规范存储在 Apigee Edge 规范存储区中。

然后,将 API 发布到您的门户。做好以下准备:

  • 从规范存储区、本地目录或网址指定要用作文档来源的 OpenAPI 规范
  • 设置文档公开范围(公开、身份验证用户或所选目标对象)
  • 配置回调网址(如果需要)
  • 根据需要向 API 目录中的显示屏添加图片

第 6 步:与开发者团队共同承担应用的责任

如果您的开发者使用 Drupal 7 中的公司应用来分担应用的责任,则可以通过集成门户上的开发者团队实现相同的功能。

您的开发者会创建开发者团队,共同承担应用相关责任并管理团队成员资格,如通过开发者团队共担应用的责任(Beta 版)中所述。

您可能需要向开发者社区介绍开发者团队,并鼓励他们迁移应用,让开发者团队来共担责任并过渡到使用新的 API 密钥。然后,您可以使用 Edge API 移除所有公司应用和相关工件。

或者,您也可以将公司应用迁移到开发者团队应用,如以下社区文章中所述:将公司自有应用迁移到开发者团队

第 7 步:准备启动集成式门户

在将集成门户发布至生产环境之前,请考虑执行下表中定义的步骤。

步骤 说明
自定义您的域名 提供您自己的自定义域名,以便对您的网站进行个性化设置。

注意:此功能目前不适用于 Apigee Hybrid 集成门户。

配置分析跟踪 使用 Google Analytics(分析)或您自己的自定义分析跟踪服务来配置分析跟踪。
创建自定义搜索页 创建自定义搜索页并嵌入 Google 自定义搜索引擎。