第 1 章 为 3scale 管理的 API 创建开发者门户概述

您的 3scale 开发人员门户是 API 用户使用的网站:

  • 注册以访问 3scale 管理的上游 API
  • 有关如何使用上游 API 的文档

3scale 提供了一个示例开发者门户,它包括了大多数 API 供应商要在其开发者门户中实施的功能。这个原生开发人员门户使用示例 Echo API 来演示典型的开发人员门户的结构。在浏览原生开发人员门户后,您需要做相应的修改信息,以便您了解如何创建自己的开发人员门户。

了解和修改原生开发人员门户没有先决条件。但是,在修改原生开发人员门户以创建自己的开发人员门户后,还必须在为 API 用户打开开发人员门户前实施单点登录工作流和验证。

1.1. 为创建开发者门户提供 3scale 编辑环境

在开始创建开发人员门户前,请先浏览 3scale 提供的 Echo API 开发人员门户示例。Echo API 开发人员门户是创建自己的开发人员门户的起点。您不会从头开始创建开发者门户。相反,您可以修改原生 Echo API 开发人员门户,以创建具有您想要的外观和感觉的开发者门户。

流程

  1. 在 3scale 管理门户中,展开顶部的上下文选择器,再单击 Audience
  2. 在左侧的导航树中,展开 Developer Portal,再单击 Content。这显示了用于创建开发人员门户的主要编辑环境:

    开发者门户主要编辑环境

    Root 下,3scale 显示 Developer Portal 资源层次结构:

    1. 文档主页Show 是开发人员门户的基础页面。对于每个页面,向下滚动以查看定义页面内容的 HTML。
    2. 这些页面下的文件夹包含将 3scale 资源拉取到开发者门户的页面。例如,Account 文件夹包含用于显示并编辑 3scale 帐户的页面,该帐户时在管理门户中创建的 3scale 管理员。使用这些页面作为起点,并根据需要对其进行修改。
    3. 在右上角,通过 New Page 下拉菜单可以添加一个页面、布局、部分、部分、文件或 portlet。选择每个选项查看您提供的信息来创建。
  3. 在选择了 Developer Portal > Content 时,将资源层次结构向下滚动到几乎底部,直到您看到 Layouts 并点 Main layout
  4. 向上滚动到顶部,可以看到 布局"Main Layout" 标题。

    在内部标题和系统名称后,您可以看到 Liquid 已启用。liquid 是 3scale 用于显示和处理 3scale 系统中的大部分数据的框架。定义页面内容的代码包含 Liquid 标记和 HTML。您可以在 Draft 选项卡中看到它,其中包含 Developer Portal 页的主布局的代码。

  5. 在左侧的导航树中,在 Developer Portal > Content 下,点每个子类别来探索它: Drafts,Redirects,Groups,Logo,Feature Visibility, 和 ActiveDocs
  6. 在左侧的导航树中,单击 Developer Portal 下的导航树,单击 Visit Portal,这是最后一个条目。

    新的浏览器选项卡显示 3scale 提供的 Echo API 开发者门户的开发版本的网站。您可以使用此开发版本来查看 3scale 原生开发人员门户。然后,您可以迭代地自定义和查看对原生开发人员门户所做的更改,以创建自己的开发人员门户。

    您知道,这是开发人员门户的开发版本,因为它在顶端的 Draft|Published 右侧有一个深灰色的面板。Draft 视图支持迭代/递增改进。当 Draft 版本查找并的行为方式时,您可以发布它。

    右侧的面板列出了提供当前页面内容的元素:

    1. 页面主页
    2. Layout Main layout
    3. Partial Submenu
    4. Partial analytics
  7. Page Homepage。新的浏览器标签页会显示 Developer Portal 编辑环境,其中包含 Page 'Homepage' 用于编辑。
  8. 返回到 Echo API 开发人员门户的开发版本,再单击右上角的 SIGN IN,它会显示 API 用户用来登录到您的开发人员门户的 SIGN IN 页面。

    在右边的灰色面板中,模板列表下方,是一个用户名和密码,可用于模拟使用开发人员门户的签名:

    1. SIGN IN 页面中,在 USERNAME OR EMAIL 字段中输入 John,这是右侧灰色面板中列出的用户名。
    2. PASSWORD 字段中,输入 123456,这是灰色面板中列出的密码。
    3. Sign In 显示 Developer Portal,因为您的 API 用户会看到它。

后续步骤

继续探索原生开发人员门户,如您想要的那样。当您熟悉编辑环境和 Echo API 开发人员门户的开发版本时,请遵循 修改 3scale 原生开发人员门户 的步骤。