跳到主要内容
版本:3.3.x

API 产品

将 API7 门户想象成你的数字店面,向开发者展示你提供的宝贵 API。 在此店面中,API 产品 充当精选的 API 组合包,根据特定需求和用例量身定制。 就像商店可能会提供不同的产品套餐一样,你的 API 门户使用 API 产品会更易于理解、使用和管理你的 API。

概述

API 产品本质上是一个包含一个或多个 API 的集合,是开发者订阅或购买你的 API 的最小单位。

API7 门户支持两种类型的 API 产品:

  • 从 API7 网关创建(推荐): API 产品利用来自 API7 网关的已发布服务,实现集中管理并简化向开发者的交付。API7 门户将支持这些 API 产品的订阅管理和未来的货币化功能。对已发布服务的更改会自动反映在 API7 门户上的关联 API 产品中,从而确保为你的开发者提供无缝更新。
  • 导入 OpenAPI: 使开发者能够在 API7 门户中探索外部 API。此功能为开发者提供了一个沙盒环境,以便与未托管在 API7 网关上的 API 进行交互。导入的 API 不支持身份验证、订阅和货币化等高级功能。

使用优势

  • 简化使用: 开发者可以轻松发现和订阅所需的 API 集合,而无需了解底层服务架构。
  • 有针对性的产品: 为不同的受众或用例创建不同的 API 产品(例如,具有有限访问权限的“入门”产品,具有更高配额的“高级”产品)。
  • 高效管理: 将策略应用于一组 API 并将其作为一个单元进行管理。
  • 改善开发者体验: 清晰、有条理地展示你的 API 产品,使开发者更容易找到他们需要的内容并快速入门。

与已发布服务的关系

API 产品可以由来自 API7 网关的多个已发布服务组成。但是有以下限制:

  • 一对一关联:已发布的服务只能与单个 API 产品关联。
  • 网关组限制:来自相同服务模板的、不同网关组的已发布服务不能包含在同一 API 产品中。

已发布服务 - API 产品关系会帮助你的开发团队内部明确各自的角色和职责。

工程师专注于技术方面:

  • 设计、开发和维护已发布的服务。
  • 确保 OpenAPI 规范的准确性和质量。

API 产品经理专注于业务方面:

  • 根据开发者需求定义和管理 API 产品。
  • 监督订阅管理和开发者参与。
  • 驱动整体产品战略。

这种职责划分有助于更高效、更有效地进行 API 开发和管理。

相关阅读