开始配置 Developer Portal 站点

针对品牌或主题配置 Developer Portal 所涉及的主要任务的快速入门指南。

开发人员门户网站基于开源的 Drupal 10 内容管理软件,因此几乎可以定制。 以下部分将指导您完成最常见的任务,以开始将 Developer Portal 标记为符合您的组织需求,包括指向主目录中相关主题的链接。 主目录中还介绍了更多自定义选项。 在此内容中查找特定自定义帮助的最佳方法是使用文档搜索栏。
重要说明:

当您更新到新版本的 API Connect时,将保留本主题中详细描述的所有定制。 Drupal 更新以及新功能,缺陷修订和安全性更新通过 IBM确定的 API Connect 更新包提供。 要了解可用的更新包,请在 IBM Fix Central上选择产品。

不允许或不支持在文件系统上直接编辑任何 API Connect 主题,模块或 Drupal 核心,因为在安装更新包时将覆盖这些文件的已编辑版本。 必须通过使用本主题中描述的适当机制(例如,定制模块和主题)来完成定制,而不是直接编辑源。

有关 API Connect 支持策略的更多信息,请参阅 IBM® API Connect 支持生命周期策略

创建定制主题

如果您希望 Developer Portal 具有公司品牌和样式,那么需要创建定制主题。 主题主要由级联样式表 (CSS) 文件组成,尽管它们可以包含更多内容; 请参阅 高级主题开发

不允许或不支持直接编辑 API Connect 主题,因为安装修订包或 iFix 时会覆盖这些文件的已编辑版本。 创建定制主题的方法是创建缺省情况下 Developer Portal 使用的标准 API Connect 主题的定制子主题。 子主题继承父主题的资源,这意味着定制子主题 CSS 文件只需要包含您希望通过缺省主题所作的更改或覆盖。 CSS 文件可以根据您的需求包含任意数量的更新。

有关更多信息,请参阅 创建子主题您还可以遵循指导您如何使用主题生成器,定制主题以及安装定制主题的教程; 请参阅 教程: 为 Developer Portal 创建定制主题

虽然拥有 Drupal 方面的经验会有所帮助,但创建子主题真正所需的唯一技能是 CSS。

更改页面布局

虽然主题首先定义了页面的区域,例如页脚或侧边栏,但页面布局是通过配置哪些块出现在哪些区域中来定义的。 通过使用 Developer Portal 管理员仪表板上的 结构 > 块布局 选项来控制块。 然后,您可以进一步限制这些块,以仅显示在特定页面上,或显示在除特定页面以外的所有页面上,仅为某些角色或某些语言而显示等等。

有关如何配置页面布局的信息,请参阅 添加和更改 Developer Portal 页面上显示的块

更改页面布局完全在 Developer Portal UI 中以管理员身份完成。

更改首页

首页是特殊情况,不会使用先前提到的块系统。 而是从 Developer Portal 管理员仪表板上的 结构 > 页面 选项对其进行配置。

有关如何配置首页的信息,请参阅 配置首页

设计首页时可能要考虑的更多选项包括:

同样,更改首页完全在 Developer Portal UI 中以管理员身份完成。

高级主题开发

页面的特定块和部分的 DOM 结构是通过模板来控制的。 这些模板是 Twig 文件,用于定义特定内容部分的实际 HTML 输出。 您可以通过将原始模板复制到定制子主题的 templates 文件夹中,然后按规范编辑模板来覆盖 Twig 模板。 然后, 开发者门户网站 将优先使用您的模板而不是原始模板。 有关更多信息,请参阅 应用修改后的内容类型模板

通过修改 Twig 模板,能够以非常细粒度的方式控制页面的结构。 但是,这也意味着您可能会错过对原始模板进行的新功能和缺陷修订,因为 Developer Portal 使用的是覆盖而不是原始模板。 因此,如果覆盖模板,那么您将负责检查最新 API Connect 发行版中的模板,并确保对覆盖进行所需的任何等效更改以保持功能等同。

如果您正在开发定制模板,建议您了解 Twig 模板语言、Drual、HTML 和 CSS。

定制模块

如果需要修改 Developer Portal的功能行为,那么可以创建定制模块来执行此操作。 Drual 具有围绕挂钩系统构建的可扩展编程 API。 通过在定制模块中使用这些挂钩,您可以更改不同情况下发生的状况,例如,显示表单、提交表单或者为定制模板和其他选项提供附加变量等情况。

有关编写定制模块的更多信息,请参阅 扩展您还可以遵循包含使用定制模块的教程,请参阅 教程: 向注册表单上的字段添加验证

定制模块是使用 PHP 编写的,因此 Drupal 经验和 PHP 知识非常有用。

隐藏管理登录表单

如果 Developer Portal 面向公共,那么您可能希望在登录表单上隐藏管理员注册表作为选项。 只需从管理员仪表板单击 配置 > 系统 > IBM API Developer Portal,然后选择 在登录表单上隐藏管理注册表即可执行此操作。 有关更多信息,请参阅 在登录表单上隐藏管理注册表

后续操作 - 浏览主配置内容

Developer Portal上几乎有无限个可供您使用的配置选项。 浏览以下部分以了解更多信息:
  • 外观 -控制常规外观元素,并了解如何创建定制主题。
  • 内容 -添加,配置和控制内容元素,例如元标记,定制页面,定制内容类型以及向 API 或产品添加内容。
  • 结构 -控制门户网站中内容的显示方式,例如,配置首页,更改块显示以及使用 "视图" 模块。
  • 配置 -配置内容审核,执行常规配置任务以及管理 Developer Portal 安全性。
  • 人员 -创建和定制站点配置角色,控制对站点和内容的访问,以及创建内部使用者组织以允许定制特定 API 属性。
  • 论坛 -创建和控制论坛。
  • Reports -有关站点的常规配置和状态的可用报告列表。
  • 扩展 -有关创建定制模块的简介和指示信息,包括有关在 PHP 中进行开发以及如何在定制模块中使用挂钩的信息。
  • Developer Portal 教程 -指导示例指导您完成简单且更复杂的配置区域。