您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息
使用 Drupal 的“基本页面”内容类型,您可以向开发者服务门户添加有关 API 的文档(例如方法指南和 API 参考文档),并添加视频、抓屏或代码下载等内容。
文档页面设置了一些初始条目,这些条目按各种类别(例如“使用入门”和“教程”)进行整理。该页面是您编辑的起点。通过这种方式,您可以添加自己的内容条目,并以所需的方式组织这些条目。
添加文档首页
默认情况下,文档首页位于开发者门户上的 <site网址>/documentation 中。开发者门户的默认首页会在首页顶部的框中包含指向此页面的链接:
您还可以在开发者门户菜单的主菜单中添加指向此页面的文档链接。
不过,默认情况下文档首页不存在,因此您必须在开发者门户上的正确网址创建新页面。
如需将文档首页添加到开发者门户,请执行以下操作:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择内容 > 添加内容 > 基本页面。
- 输入文档的标题(例如文档首页)以及第一页的内容。
- 点击修改摘要可添加摘要。
- 点击 Body 部分下方的 Menu 设置项。
- 选择提供菜单链接,添加链接标题,然后在“父级项”中选择 <Main menu>。
此操作会添加一个指向文档首页主菜单的链接。 - 点击“正文”部分下的网址路径设置项。
- 取消选择生成自动网址别名,并将网址别名设置为文档。
默认情况下,网页的网址为 <site网址>/content/pageName。通过设置网址别名,您可以设置网页的明确网址(在本例中为 <site网址>/documentation)。 - 保存页面。
现在,您应该会在菜单栏中看到指向该网页的链接,首页框中的链接现在应该也能正常运行。
作为管理员,您还会看到内容管理按钮,例如“查看”和“修改”。 非管理员不会看到这些内容。
在文档中添加子页面
在文档中添加子页面时:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择内容 > 添加内容 > 基本页面。
- 输入网页标题和内容。
- 点击修改摘要可添加摘要。
- 点击 Body 部分下方的 Menu settings 项。
- 选择提供菜单链接,然后添加文档首页菜单项。
此操作会将当前页面添加为文档首页主菜单的子级。 - 现在,您应该会在 Documentation Home 页面菜单中看到指向相应页面的链接。
修改文档页面
如需修改页面,请执行以下操作:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 前往开发者门户中的相应页面。
您也可以点击 Drupal 管理菜单中的内容,列出您的所有页面,然后选择一个页面。 - 选择页面上的修改标签页。
- 在“正文”部分下方的“文本格式”下拉菜单中选择“完整 HTML”或“过滤的 HTML”,即可打开可视化编辑器。
您应该会在编辑器中看到页面内容。 - 根据需要修改页面。
- 点击“保存”。
显示任何文档页面
如需显示文档内容,请执行以下操作:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 在 Drupal 管理菜单中选择内容。
- 选择您要查看的文档。
重新排列页面顺序
您可以在“文档首页”菜单中更改页面的顺序和嵌套级别。
如需重新排列文档首页菜单中的页面,请执行以下操作:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择结构 > 菜单 > 主菜单。
- 菜单中的每项内容的名称左侧都有一个图标。如果您没有看到这些图标,请点击隐藏行权重。
- 要移动某项,请点击并拖动相应图标,将其移动到新位置。
拖动包含子项的项时,会同时移动子项。
- 点击 Save Configuration(保存配置)。
编辑页脚页面
门户的页脚包含三个 Twitter、Facebook 和 LinkedIn 社交图标,以及以下网址的链接:
- 指向 <site网址>/privacy-policy 网址的隐私权政策
- 网址 <siteURL>/terms-use 的条款及使用
- 指向网址 <siteURL>/contact-us 的联系页面
修改这些网页,以添加您自己的内容。
如果这些网页不存在,请按以下步骤创建:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择内容 > 添加内容 > 基本页面。
- 输入文档的标题(例如《隐私权政策》)以及页面内容。
- 点击修改摘要可添加摘要。
- 点击“正文”部分下的网址路径设置项。
- 选择生成自动网址别名,然后将网址别名设置为 privacy-policy。
默认情况下,网页的网址为 <site网址>/content/pageName。通过设置网址别名,您可以设置网页的明确网址(在本例中为 <site网址>/privacy-policy)。 - 保存页面。
- 在“条款和使用”和“联系信息”页面上重复此流程。
如需修改开发者门户中页脚页面(例如“隐私权政策”“使用条款”或“与我们联系”页面)的内容,请执行以下操作:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 点击页脚中的链接即可转到相应页面。例如,点击隐私权政策链接。
- 点击该页面上的修改标签页以打开编辑器。
- 根据需要更改“隐私权政策”页面的内容。
- 点击保存。
- 在“条款和使用”和“联系信息”页面上重复此流程。
如需修改开发者门户中的社交图标,例如 Twitter、Facebook 和 LinkedIn 图标,请执行以下操作:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择结构 > 块。
- 在“块”页面上向下滚动,直到看到网站级默认页脚块。
- 选择与网站级默认页脚版块对应的configure链接。
- 在 Custom Content 区域中,右键点击社交图标,然后从弹出式菜单中选择 Edit Link(修改链接)。或者,从自定义内容区域删除该图标即可将其移除。
- 选择保存代码块以保存更改。
向门户页面添加 JavaScript
您可以将 JavaScript 添加到任何门户页面。添加 JavaScript 的最简单方法是编辑页面,然后执行以下操作:
- 选择完整 HTML 作为文本格式。
- 选择源代码按钮,修改该网页的 HTML 源代码。
- 将 JavaScript 添加到网页中。例如,如需在网页加载时弹出提醒框,请添加以下代码:
<script language="JavaScript">
alert('Welcome to my page!');
</script>
使用 JavaScript 时的一些注意事项:
- 如果您要引用 JavaScript 文件,请不要在节点的源代码中引用,因为这样会创建一个静态链接。应改为使用 PHP 代码来创建动态链接。这样一来,如果 JavaScript 文件的位置发生更改,您就无需更新引用该文件的所有门户页面。
- 如果要包含 JavaScript 文件,请将其添加到门户主题中。或者,如果它是某个 Drupal 模块的一部分,请将其添加到此模块中。
- 您还可以使用 Drupal drupal_add_js 函数在 Drupal 中添加 JavaScript。如需了解详情,请参阅 https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7。
检查是否存在损坏的链接
建议您检查自己的内容是否存在损坏的链接。默认情况下,开发者门户被设置为检查各种类型的网页是否存在损坏的链接。例如,系统会检查基本页面、文章、博文和论坛主题中的链接。
在链接检查中添加或移除网页类型:
- 在 Drupal 管理菜单中,选择模块,并确保已启用链接检查器模块。
- 在 Drupal 管理菜单中,依次选择配置 > 内容创作 > 链接检查工具。
- 配置您要扫描其中是否存在损坏链接的内容类型。
配置搜索
开发者门户提供了一个由 Apache Solr 实现的内置搜索引擎,它使用 Apache Lucene 搜索库。该网站本身的搜索引擎,用户可通过所有门户页面右上角的搜索框进行访问。
外部搜索引擎(例如 Google)也可以将您的门户编入索引。通过开发者门户,您可以控制外部搜索引擎能否将您的门户编入索引。
配置 Apache Solr
您可以配置 Apache Solr 来控制要编入索引的内容类型、强制编入索引以及执行其他配置任务。
如需配置 Apache Solr,请执行以下操作:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择配置 > 搜索和元数据 > Apache Solr 搜索。
- 使用此页面配置 Apache Solr。
停用 Google 索引编制
将您的内容编入索引并使其可供搜索引擎访问的好办法。默认情况下,Google 索引器会将您的内容编入索引。不过,您可以选择停用 Google 索引编制。如果您的开发者门户尚未准备好供公众使用,并且您不想公开自己的内容,建议您执行此操作。
若要停用 Google 索引编制,请执行以下操作:
- 以拥有管理员或内容创建权限的用户身份登录门户。
- 在 Drupal 管理菜单中选择模块。
- 启用元标记模块。
- 点击 Save configuration(保存配置)。
- 在 Drupal 管理菜单中,依次选择配置 > 搜索和元数据 > 元标记。
- 对于全局类型,选择替换操作。
- 点击高级部分将其打开。
- 选中“阻止搜索引擎将此网页编入索引”复选框。
- 点击保存。
请注意,“全局”页的“高级”部分中还有其他与搜索引擎相关的选项。例如,您可以选中相应的复选框来阻止搜索引擎跟踪网页上的链接。根据情况选中一个或多个复选框。
记录如何注册应用
请务必在您的文档中说明开发者如何通过您的开发者门户注册其应用。您可以从以下说明入手,其中介绍了如何通过默认开发者门户注册应用。
如需配置开发者在您的门户上注册应用的方式,请参阅配置应用注册了解详情。如果您修改了应用注册流程,请相应地修改以下示例说明。
如需通过默认开发者门户注册应用,请执行以下操作:
- 在登录菜单中,选择用户名下方的我的应用。
- 点击添加 (+) 新应用图标。
- 在“添加应用”页面输入适当的值:
应用名称 请为您的应用提供一个唯一的应用名称。 回调网址 如有必要,请提供 OAuth 调用应返回至的回调网址。
默认情况下,即使您的 API 不使用 OAuth,该值也是必需的。如果您的 API 不使用 OAuth,请输入一个虚拟值,例如 my.site.com。
产品 选择一个或多个 API 产品。. - 点击创建应用以注册应用,并生成应用的 API 密钥。