构建门户的最佳做法

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

Apigee 建议您在构建门户时应用以下部分中介绍的最佳做法。

吸引受众群体

添加可在视觉上吸引受众群体并促使他们了解详情的内容。使 API 使用方无需登录即可浏览门户的一部分。提供自助注册，以便他们可以快速启动并运行，使用您的 API 构建应用。

从您的 OpenAPI 规范自动生成互动式 API 文档，以让用户可以：

提供与您的受众群体相关的用例示例和教程，具体取决于他们的经验水平。通过示例进行演示，例如简单的 curl 命令序列，或逐步执行更复杂的过程。

确保您的内容可搜索。投资于可提高您在搜索结果中排名的 SEO，并让用户能够找到您的内容。

搜索引擎优化

在构建内容时，使用以下最佳做法。如需了解详情和 Google 提供的其他准则，请参阅 Google 搜索引擎优化入门指南。

最佳做法	说明	优势
创建方便用户使用的网址	创建易于理解、直观易懂的网址。按照创建页面中的说明，在向门户添加页面时定义方便用户使用的页面网址。	以直观易懂的形式传达网页的用途。页面网址中的完全或部分关键字匹配可以提高搜索排名。通常，网址会显示在搜索结果中。
提供描述性门户名称	请按照管理门户中的说明为门户定义唯一的描述性门户名称。此内容用于填充门户首页 (`index`) 的 `<title>` 标记。	标题中的完整或部分关键字匹配可以提高搜索排名。通常，页面标题内容显示为搜索结果的第一行。
让您的网站易于导航	按照设置导航中的说明，定义具有逻辑意义的导航结构。	保持以用户为导向。帮助用户快速轻松地找到所需内容。
在内容中有效地混用关键字词组	在内容相关且有意义时在内容中包括关键字。页面上关键字字符串的显眼程度可以提高页面在搜索结果中的排名。尝试预测用户在搜索您的内容时可能使用的关键字字符串。请务必注意关键字内容，即不要仅出于提高搜索排名的目的来过度使用关键字。这可能会导致您的网站受到搜索引擎的影响。	搜索内容的用户更有可能获得相关命中。

利用社交媒体通过标准社交渠道（例如 Facebook、Twitter 等）推广您的 API 社区。发布博客和论坛，促进 API 社区中开发者之间的交流和互动。