API Connect 组件

API Connect 组件为整个 API 生命周期提供统一的用户体验。 API 生命周期的一个阶段中的更改会自动反映在 API Connect的其他组件中。

Cloud Manager

API Connect Cloud Manager 组件用于管理 API Connect 内部部署云。 云管理员使用此 UI：
  • 定义云中所需的管理服务器、网关服务器和容器的集群，并配置拓扑。 有关管理服务器和网关服务器的信息，请参阅 API Connect 服务器需求。 有关容器的信息，请参阅 运行时。
  • 管理（修改、移动、移除、重新启动和重新引导）云中的服务器。
  • 监视云的运行状况。
  • 定义并且管理开发 API 的提供者组织。 （分配的提供者组织的管理者或所有者也可完成此任务。）
  • 定义其他云管理员，或设置其角色支持访问特定功能的用户。
  • 添加用户注册表以认证用户和保护 API，配置数据的安全传输（例如，通过 Web 站点）。

有关 Cloud Manager的更多信息，请参阅 管理云。

开发者工具箱

开发者工具箱 提供了用于对 API 进行建模，开发和测试的工具。 开发者工具箱 包含命令行界面 (CLI) 和相应的图形用户界面 API Designer。

API 开发者使用 API Designer 或 CLI 中的 API 管理功能为 REST 和 SOAP API 或用于 OAuth 2.0 认证的 OAuth 提供者端点创建草稿 API 定义。 API 定义可以配置为将 API 添加到产品，添加策略组合件流（用于处理请求/响应）和定义安全选项及其他设置。 然后，可以在发布之前在本地测试 API，以确保对其正确定义和实现。

使用 API Designer或 CLI 创建的草稿 API (在其包含的产品中) 将发布到目录。

开发者工具箱 安装在本地，用于脱机 API 和应用程序开发。 有关 开发者工具箱的更多信息，请参阅 开发 API 和应用程序。

API Manager

API Manager 提供了一个用户界面，便于对产品和计划中打包的 API 进行促销和跟踪。 API 提供者可在产品的生命周期中移动产品以及管理 API 和计划的可用性和可视性。

将在 API Manager 中创建目录和 空间 ，以充当登台目标，通过这些目标将 API ，计划和产品发布到使用者组织。 API 提供者可以将其产品登台到目录或 空间，然后发布这些产品以在 Developer Portal 上显示这些产品中的 API 以进行外部发现。

要控制对可用 API 管理功能的访问权，可以在 API Manager UI 中使用分配的角色和许可权来设置提供者组织中的用户。 API 提供者还可以使用 UI 来管理那些注册访问其 API 和计划的使用者组织。 要将使用者组织分组以便为各组提供一组特定的产品和计划，可以额外创建开发人员社区。

API Manager UI 还包含用于管理 API 环境安全性的功能，并提供对可定制仪表板视图中有关 API 调用度量的分析信息的访问。

有关 API Manager的更多信息，请参阅 管理 API。

API Gateway

网关实施运行时策略以保护和控制 API 流量，提供用于向调用应用程序公开 API 的端点，还提供可使 API 与各个端点集成的组合件功能。 他们还会将所有 API 交互记录并报告到 API Connect 分析引擎，以进行实时和历史分析和报告。

API Connect 支持以下类型的 API 网关：

  • DataPower Gateway (v5-compatible)

    DataPower® Gateway是一款企业级 API 网关，专为部门和跨企业使用而构建。 在 V10 API Connect 中，DataPower Gateway 与 V5 DataPower Gateway 兼容、因此在文档中称为"v5-compatible"（或"v5c"）网关。 v5-compatible 网关提供了一组全面的 API 策略，用于安全性，流量管理，调解，加速和非 HTTP 协议支持。

  • DataPower API Gateway

    DataPower API Gateway 的设计具有与 DataPower Gateway (v5-compatible) 相同的安全性焦点。 其中， DataPower Gateway (兼容v5 ) 是为了实现灵活性而构建的， DataPower API Gateway 是专门针对 API 用例而构建的，所产生的性能 benefits.DataPower API Gateway 。 如果您是在公共云或私有云中运行应用程序，并且希望将其作为 API 公开，请使用此网关。

API Connect 部署可以包含虚拟 DataPower Gateway。 根据特定条件，还提供了对物理 DataPower Gateway 的支持。

有关网关及其功能的比较的更多信息，请参阅 网关类型。

运行时

您可以在容器化运行时中的 API Connect 中运行应用程序和 API 实现。
容器化运行时
容器化运行时环境为 API 和应用程序提供轻量级部署位置。 容器将应用程序打包在完整文件系统中，此文件系统包含运行所需的所有对象，例如，代码、运行时、系统工具和系统库。 您可以使用 Docker Swarm 或 Kubernetes 容器来运行由 API Connect管理的 API 和应用程序。

Developer Portal

开发者门户网站 为应用程序开发者提供可定制的基于 Web 的自助服务门户网站，以探索，发现和预订 API。

当 API 提供者在 API Manager中发布 API 时，这些 API 将在 开发者门户网站 中公开，以供使用者组织中的应用程序开发者发现和使用。 应用程序开发者可以访问 Developer Portal UI 以注册其应用程序，发现 API ，在其应用程序中使用所需 API (必要时进行访问核准) ，然后部署这些应用程序。

Developer Portal 提供了其他功能，例如论坛，博客，评论和评级，用于社交化和协作。 API 使用者还可以查看有关应用程序所使用的 API 以及在使用者组织中使用的 API 的分析信息。 有关更多信息，请参阅 Developer Portal: 社交化 API。

API 分析

API Connect 提供了过滤，排序和聚集 API 事件数据的功能。 然后，将在相关图表，表和映射中显示此数据，以帮助您管理服务级别，设置速率限制，建立控制，设置安全策略，管理社区和分析趋势。 API 分析是在 OpenSearch 开放式源代码实时分布式搜索和分析引擎上构建的。 有关更多信息，请参阅 分析: 了解 API 使用情况。

API Connect 服务器需求

在本地云中，您可以创建、升级、使用和跟踪 API。 本地云由各种设备组成，其中每个设备均是特定类型的服务器。 服务器集合可定义云，并确定如何分发数据的管理、分析、路由和存储工作。

本地云可以由新的和现有的物理设备与虚拟设备组成，也可以完全由虚拟设备组成。 API Connect 环境中服务器的类型和数量由每个企业的个人需求决定，但最低需求是一个 管理 服务器，一个分析服务器，一个 网关 服务器和一个托管 Developer Portal的服务器。

API Connect 本地云包含以下服务器类型:
  • 管理服务器。 存储所有云配置，并控制 API Connect中其他服务器之间的通信。 管理 API Connect 云中各个服务器的操作，并提供用于与各个服务器进行交互的工具。 Cloud Manager 和 API Manager 用户界面在 管理 服务器上运行。
  • 分析服务器。 提供分析功能，用于收集并存储有关 API 和 API 用户的信息。
  • 网关服务器。 处理和管理安全协议并存储相关用户和设备认证数据。 Gateway 服务器还提供了使 API 能够与各种端点 (例如，数据库或基于 HTTP 的端点) 集成的组装功能。
  • Developer Portal 服务器。 提供带完整功能内容管理系统的可定制社交 Developer Portal，包括集群功能。 使 API 提供者可为其应用程序开发人员构建门户网站，为应用程序开发人员提供界面来发现 API 和预订在已发布产品中包含的使用计划，以在应用程序中使用。
注: API Connect 云中的所有管理设备都必须在彼此相同的固件级别运行。 各个网关设备可以运行在不同的固件级别上，但建议所有网关设备都运行在相同的级别上。

按界面组件列出的典型任务

API Connect 提供了命令行界面和图形用户界面。 提供者组织和使用者组织将使用不同的界面来完成典型任务。 请参阅下表以查找与特定任务对应的界面。

表 1. API Connect 每个界面组件的任务
组织类型 界面组件 任务
API 提供程序 命令行界面 (CLI) 创建 API、计划和产品
API Designer UI 创建 API、计划和产品
API Manager UI 创建目录和空间；创建使用者组织
Cloud Manager UI 创建提供者组织
API 使用者（应用程序开发人员） Developer Portal 访问 API 以创建和运行应用程序；创建使用者组织

如果为目录启用了自助服务加载，那么当应用程序开发者注册或由 API 提供者邀请到 开发者门户网站时，将自动创建使用者组织，然后应用程序开发者将成为该使用者组织的所有者。