1.2. 修改 3scale API 管理原生开发人员门户
探索 Echo API 开发人员门户后,在开始创建自己的开发人员门户前对它进行一些更改。这些实践步骤有助于为开发人员门户创建准备工作。
此流程将示例 3scale Echo API 登录页标题替换为通用 Swagger Petstore API 的标题。它还介绍了如何更新开发人员门户来显示 Petstore API 的文档。
流程
- 在 3scale 管理门户中,展开顶部的上下文选择器,再单击 Audience。
- 在左侧的导航树中,展开 Developer Portal,再单击 Content。
在 Root 下,单击 Homepage,它是 Developer Portal 登录页面的内部标题,并更改 Developer Portal 开发版本中显示的登录页面标题:
- 在 Page 'Homepage' 中,向下滚动以查看呈现登录页面的代码。
在第
5
行,更改<h1>Echo API</h1>
至
<h1>Petstore API</h1>
- 在页面底部,单击 Publish。
- 在左侧的导航树中,点击 Developer Portal 下的导航树,单击 Visit Portal 以显示开发人员门户的开发版本,并可以看到登录页面标题现在是 Petstore API。
- 保留开发人员门户的开发版本,再单击位于顶部菜单栏中的 Documentation。Developer Portal 为 Echo API 显示 ActiveDocs。
- 返回到 3scale 管理门户并选择 Developer Portal > ActiveDocs 查看 Echo API 的条目。3scale 提供定义 Echo API 的 OpenAPI 文档。3scale 使用这个 OpenAPI 文档为 Echo API 显示 ActiveDocs。
导入定义 Swagger Petstore API 的 OpenAPI 文档:
- 进入 https://petstore.swagger.io/v2/swagger.json,并将 JSON 内容复制到您的剪贴板中。
- 返回到带有 Developer Portal > ActiveDocs 的 3scale 管理门户。
- 在 ActiveDocs 页面中,点击 Create a new spec。
-
在 Name 字段中输入
Petstore
。 - 选择 Publish?。
- 点击 API JSON Spec 窗口,粘贴剪贴板中的 Swagger Petstore JSON 内容。
- 点页面底部的 Create Spec。3scale 为 Petstore API 显示 ActiveDocs。
- 在左侧的导航树中,单击开发人员门户下的 ActiveDocs。在 Echo API 之后,会有一个 Petstore 的第二个条目。
在 Developer Portal 中显示 Petstore API 的文档:
- 在左侧的导航树中,单击开发人员门户下的内容。
- 在 Root 下,单击 Documentation,这是 Developer Portal 文档页面的内部标题。
在 Page 'Documentation' 中,向下滚动以查看呈现文档登录页面的代码。第
5
行标识开发者门户显示 ActiveDocs 的 OpenAPI 文档。第5
行的默认值为:{% assign spec = provider.api_specs.first %}
默认行为是,您的开发人员门户在 Developer Portal > ActiveDocs 页面中显示 ActiveDocs 的 ActiveDocs,最初是 Echo API。此图突出显示了第
5
行:修改第
5
行,以将provider.api_specs.first
更改为一个索引,用于识别 ActiveDocs 页面中的第二个条目:{% assign spec = provider.api_specs[1] %}
默认行为是,您的开发者门户只会显示 ActiveDocs 文档。要显示多个 OpenAPI 文档的 ActiveDocs,您必须在这个简单更改之外修改 Documentation 页面。
- 在页面底部,单击 Publish。
- 在左侧的导航树中,单击 Developer Portal 下的导航树,单击 Visit Portal 以显示开发人员门户的开发版本。
- 在顶部菜单栏中,点 Documentation 查看 Swagger Petstore 文档。
后续步骤
通过更改原生的 Developer Portal 页面来创建开发人员门户,以便它们显示有关对 3scale 管理的 API 和 API 文档的访问信息。