搜索和过滤 API

本页面适用于 ApigeeApigee Hybrid

本主题介绍如何使用依托 AI 技术的智能搜索和基于过滤条件的搜索选项来搜索 API Hub 中的特定资源。

您可以使用智能搜索轻松查找和查看 API Hub 中注册的 API 资源。借助智能搜索,您可以使用自由文本搜索查询来搜索实例中的所有可用 API 资源。您可以搜索所有实体类型(API、API 操作、规范等),也可以指定要查询的实体类型。

借助依托 AI 技术的搜索引擎,智能搜索能做到的不止“匹配”字词这么简单。智能搜索返回的结果是 API 资源条目的列表,这些资源条目的详细内容中包含了在语义上与输入的自由文本搜索查询类似的字词。

自由文本搜索会返回包含以下详细信息的搜索结果的分页列表:

  • 资源名称:API、API 操作或规范文件的名称。
  • 资源说明:资源的简要说明。
  • 资源所有者:资源所有者的姓名和电子邮件地址。
  • 资源详细信息链接:资源详细信息页面的链接。

要搜索包含特定字词的 API,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 API Hub 发现页面。

    转到 API Hub 发现

  2. 在搜索框中输入搜索查询。

    例如,您可以输入“订单管理 API”或“无线运营商设置的规范文件”。

    您可以使用系统属性作为搜索参数来优化搜索。如果您在 API Hub 中注册 API 时创建了用户定义的 API 属性,也可以在搜索查询中包含这些属性。

  3. 搜索结果列表会显示一个 API 资源列表,这些资源包含在语义上与您输入的搜索查询相似的字词。
  4. 点击 API 资源名称以查看该资源的详细信息页面。
  5. 如需清除当前查询,请点击清除结果
// 待办:此功能是否为预览版?我们是否有 REST 示例?

基于过滤条件的搜索选项

您可以将系统属性用作搜索参数,以优化 API 页面上显示的 API 列表。如果您在 API Hub 中注册 API 时创建了用户定义的属性,也可以在搜索查询中包含这些属性。使用以下选项之一来自定义显示的 API 资源列表:

过滤

使用基于过滤条件的列表搜索,您可以根据一系列与资源关联的预定义参数和系统属性来精简 API 列表。您可以使用 Match ALLMatch ANY 选项来自定义过滤视图。

如需指定过滤条件选项,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 API Hub API 页面。

    转到 API Hub API

  2. 点击过滤条件以过滤表格。此时会打开过滤条件窗格。
  3. 指定过滤条件选项或从以下各项中选择过滤条件选项:
    • 匹配类型:选择匹配类型以显示符合所有条件 (AND)符合任一条件 (OR) 的 API。
    • 生命周期阶段:API 开发的渐进阶段
    • 目标用户:API 的预期用户(使用方)
    • 样式:API 的主要架构样式
    • 团队:负责 API 的制作团队
    • 业务部门:负责 API 的业务部门
  4. 点击 切换面板以关闭过滤条件窗格。
  5. 所选过滤条件属性会显示过滤条件查询使用的条件逻辑(AND 或 OR)。

  6. 如需清除单个过滤条件,请点击过滤条件上的 X。 如需清除所有过滤条件,请点击过滤条件窗格中的全部清除

排序

如需对显示的 API 列表重新排序,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 API Hub API 页面。

    转到 API Hub API

    默认情况下,系统会显示 API 列表页面。

  2. API 列表页面中,找到 API 名称列标题。
  3. 箭头表示当前排序优先级。 向下箭头表示降序。 向上箭头表示升序。
  4. 点击 API 名称可按名称对 API 列表进行排序。

分页

如果有多个 API 资源,它们可能会显示在多个页面中。

如需自定义列表显示方式并在页面之间导航,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 API Hub API 页面。

    转到 API Hub API

    默认情况下,系统会显示 API 列表页面。

  2. API 列表中,按如下所示找到分页工具:

  3. 选择要在每页显示的 API 数量。
  4. 点击 > 前进以转到下一页。
  5. 点击 < 返回以转到上一页。

后续步骤