构建集成式门户

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

Apigee Edge 提供了一个简单易用的集成式门户，用于记录和管理对 API 的访问，并推动您的应用开发者社区发展。

Apigee Edge 的所有用户都可以使用集成的门户开发工具，使他们能够快速构建自己的开发者门户，为基于 Drupal 的门户开发提供了替代方案。如需了解功能对比情况，请参阅开发者门户功能对比。

观看此视频短片，了解有关如何构建和发布集成门户。

主要功能和优势

集成式门户为您提供了以下主要功能和优势：
功能 优势
门户内容开发 快速轻松地开发门户内容。
  • 使用简单易用的页面编辑器创建页面
  • 使用 Markdown 和 HTML 撰写内容
  • 添加用于浏览门户的菜单
门户外观和风格 使用 SCSS 样式表和个性化品牌信息，全面自定义您的门户外观和风格。
API 文档 根据您的 OpenAPI 规范自动生成 API 参考文档。
自助注册 为开发者提供自助注册，以便使用您的 API 构建应用。
受众群体管理 控制谁可以访问门户内容和 API
分析 配置 Google Analytics（分析）和自定义分析跟踪。
高级自定义 执行高级门户自定义，包括：
  • 自定义您的域名
  • 添加自定义注册字段
  • 使用脚本扩展门户
  • 配置您的电子邮件

开始构建门户

Apigee 如何在集成式门户中解决安全性问题

下表介绍了 Apigee 如何通过集成门户中的内置功能确保安全。

功能 地址
需要 HTTPS 和传输层安全协议 (TLS) 强制执行加密通信
包括使用公共后缀列表进行的 apigee.io 域名注册 禁止在 apigee.io 子网域上设置“超级 Cookie”
支持内容安全政策 (CSP) 配置 防御跨站点脚本攻击 (XSS) 和其他代码注入攻击
需要：
  • 表单输入清理
  • 仅限管理员使用的网站级 JavaScript 注入
 防范 HTML、SQL 或后端注入攻击
包含 x-content-type-options: nosniff XSS 标头 禁止浏览器尝试猜测 MIME 类型
包含 x-frame-options: deny XSS 标头 不允许将门户内容嵌入到 iFrame 中
包含 x-xss-protection: 1 XSS 标头 禁止在检测反映的跨站点脚本 (XSS) 攻击时加载页面
使用 CSRF 令牌 防范跨站点请求伪造
利用： 客户数据保护措施

集成式门户如何与 Edge 通信

开发者门户使用的大部分信息都存储在 Apigee Edge 上。该门户充当 Edge 的客户端。必要时，开发者门户会发送 HTTP 或 HTTPS REST 请求，以从 Edge 检索信息或向 Edge 发送信息。例如，当门户用户在门户上注册新应用时，该门户会向 Edge 发送请求以存储该应用的相关信息。

以下部分提供了更多详细信息。

应用注册和 API 密钥的存储位置

当门户用户在集成门户上完成应用注册流程时，该门户会向 Apigee Edge 发送应用的相关信息，包括应用名称和与应用关联的 API 产品。如果 Edge 成功注册了应用，那么 Edge 会向该门户返回一个 API 密钥。门户用户使用该 API 密钥访问与应用关联的 API 产品。

应用和 API 密钥的相关信息仅存储在 Edge 中，不会存储在门户中。当门户用户使用门户查看应用的相关信息时（例如通过“我的应用”页面），该门户会使用 API 密钥向 Edge 发出请求，以便访问相关信息。

同样，当门户用户添加、移除或修改应用时，该门户会将修改发送到 Edge 进行存储。

由于有关应用和 API 密钥的所有信息均存储在 Edge 上，Edge 管理员可以使用 Edge 界面或 Management API 修改这些信息。例如，管理员可以：

  • 添加、移除或修改开发者应用
  • 批准或撤消开发者应用的 API 密钥

如需了解详情，请参阅注册应用和管理 API 密钥。

应用开发者账号信息的存储位置

开发者帐号信息存储在 Edge 上，如下所示：

以下用户帐号信息存储在 Edge 上：

  • 姓氏和名字
  • 电子邮件地址
  • 用户名
  • 门户账号状态（活跃或非活跃）
  • 门户角色（经过身份验证的用户、管理员、其他）
  • 基于角色的权限
  • 门户用户作为成员的团队（如果您已注册团队功能测试版）

电子邮件地址是 Edge 用来标识开发者的主键，并且每个电子邮件地址都必须是唯一的。Edge 会根据主键为开发者所属的每个组织生成一个唯一的开发者 ID。

有关详情，请参阅注册应用开发者。

开发者团队信息的存储位置（Beta 版）

门户用户在该门户上创建开发者团队时，开发者团队的信息会存储在 Edge 上，包括：

  • 开发者团队名称和说明
  • 开发者团队成员及其角色
  • 开发者团队所分配到的应用
  • 分配给开发者团队的受众群体
  • 开发团队的创建时间

系统会为开发者团队生成一个具有唯一性的电子邮件地址，并用作 Edge 用于识别开发者团队的主键。

如需了解详情，请参阅使用开发者团队共担应用的责任（Beta 版）和管理开发者团队。

关于示例门户

创建新的门户时，系统会提供一组入门页面供您快速跳转。入门页面包含演示内容，可以在您将文本和图片替换为独特的内容时，启发您进行自己的门户开发。示例门户主题使用 Material Design 主题和 SCSS。

下面显示了示例门户的首页。

示例门户提供的入门页面包括：

网页 说明
首页 门户首页用于描述编辑精选的 API。充当门户的默认首页 (index.html)。演示如何如添加 Angular Material 组件所述使用 Angular Material 组件。
快速入门 一组快速应用步骤演示了如何自定义门户。点击示例门户中的快速入门，逐步完成将内容添加到开始使用页面的操作。
开始使用 示例内容页面。请参阅示例门户中的开始使用页面，了解如何修改此页面并将其添加到顶部导航栏中。
API 可用 API 的列表。当您生成交互式 API 参考文档时，系统会自动将内容链接添加到此页面。

注意：本页面的内容会根据您发布到门户的 API 自动生成。您无法直接修改此页面内容；它不会显示在页面列表中。您可以使用门户主题背景编辑器修改页面的样式。
我的应用 已获授权用户的已注册应用列表。请参阅门户用户如何与您的门户互动。

注意：此页面的内容是根据注册用户应用自动生成的。您无法直接修改页面内容；它不会显示在页面列表中。您可以使用主题背景编辑器修改页面的样式。
登录 适用于注册用户的登录页面。新用户可以通过点击登录通过此页面注册。请参阅门户用户如何与您的门户互动。

注意：登录页面会自动包含在门户中。您可以在登录页面上自定义徽标，并在创建账号页面添加自定义注册字段。您无法直接修改页面的内容；该页面不会显示在页面列表中。
条款及条件 条款及条件示例页面。

浏览器支持

Apigee 集成门户支持与 Apigee Edge 相同的浏览器版本。