查看发现的 API

在线编辑

如何查看 API 发现 功能中已发现的 OpenAPI 文档。

准备工作

需要下列其中一个角色才能编辑发现的 API:
  • 组织管理员
  • 所有者
  • 具有以下任何许可权的定制角色:
    • 设置: 管理
    • API-草稿: 编辑
具有 Settings: View 或 Api-Drafts: View 许可权的定制角色能够查看发现的 API。

关于本任务

API discovery 是 IBM® API Connect 的一个插件，可用于在 API 开发过程中发现和添加 API。 将源收集器添加到 API 发现功能后，就可以在 API 管理器中管理已发现的 OpenAPI 文档。

过程

要管理已发现的 OpenAPI 文档，请完成以下步骤。
  1. 在 API 管理器界面中， 单击“发现 ”图标 发现图标是黑色背景上一对白色双筒望远镜的轮廓。，然后确保已选中 “API ”选项卡。
  2. 已发现的 OpenAPI 文档的列表将显示在表中。 列表中的 OpenAPI 文档将根据其源上的配置设置进行更新。
    OpenAPI 文档可以具有下列其中一种状态:
    • 已发现 - OpenAPI 文档由源发现。
    • 复制到草稿 - OpenAPI 文档将复制到 API Manager UI 的 开发 部分中的 API 选项卡。
  3. 要查看 OpenAPI 文档的元数据，请单击要查看的文档旁边的 “选项 选项图标是一组白色背景上的三个垂直黑点。 ”图标，然后选择 “查看元数据 ”。
    这将显示 API 的简要描述。 然后，您可以单击 查看 API 以查看完整的 OpenAPI 文档，或者单击 隐藏 API 以在列表中隐藏 API。
  4. 要查看完整的 OpenAPI 文档，请单击 API 表中文档的标题。

    将显示完整 OpenAPI 文档的只读版本，您可以在 UI 中进行探索。 您还可以将 OpenAPI 文档下载为 JSON 或 YAML 文件。

  5. 要将 OpenAPI 文档复制到草稿 API 中，可以使用下列其中一种方法:
    • 在“API ”选项卡中的可用 OpenAPI 文档列表中，点击要复制的文档旁边的 “选项 ” 选项图标是一组白色背景上的三个垂直黑点。 图标，然后选择 “复制到草稿 ”。
    • 在 OpenAPI 文档中，单击 复制到草稿。

    然后，可以单击 API Manager UI 的 开发 部分中的 API 选项卡，复制的文档将显示在 API 列表中。 您现在可以在 API 管理器中编辑和管理此 API 的生命周期；有关详细信息，请参阅《 API 开发检查清单 》和 《使用 API 定义 》。

  6. 可选： 您可以点击 OpenAPI 文档旁边的 “选项 选项图标是一组白色背景上的三个垂直黑点。 ”图标，以进一步管理该文档。 提供了以下选项：
    • 下载 -下载 API。
    • 查看元数据 -用于查看 API 的简要描述。
    • 复制到草稿 -将文档复制到草稿 API 中。
    • 隐藏 API -从 API 列表中隐藏文档。 要显示隐藏的 API，请点击 “筛选器 ”图标 过滤器图标是一个漏斗形符号，顶部宽，底部窄，在 “显示 ”类别下选择 “隐藏的 API ”，然后点击 “应用 ”。 然后，可以针对要再次显示的文档选择 显示 API 选项。 要查看 API ，必须更改过滤器以清除 隐藏 API 复选框。
    • 除去 API -从 API 列表中除去文档。 如果 API 已复制到草稿，那么仅从已发现 API 的列表中除去该 API; 不会从草稿 API 的列表中除去该 API。 如果已除去的 API 仍然存在于源中，那么可以再次发现该 API。 如果要从列表中除去 API 文档，而不再发现该文档，那么可以选择 隐藏 API 选项。
  7. 可选： 您可以点击表格标题栏中的 "管理列" 图标是白色背景上黑色轮的轮廓。 “管理列 ”图标，以更改列的顺序和显示方式。

结果

您复审了已发现的 OpenAPI 文档，并将所需 API 复制到草稿以在 API Manager中启用完整 API 生命周期管理。