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

API 产品

你可以将 API7 开发者门户(API7 Portal)视为你的数字店面,向开发者展示你提供的高价值 API。在这个店面中,API 产品(API Products) 充当着精心挑选的 API 组合,专门针对特定需求和用例进行定制。就像商店可能会提供不同的产品套餐一样,你的 API7 开发者门户使用 API 产品以一种易于理解、使用和管理的方式来呈现你的 API。

概述

API 产品本质上是一个包含一个或多个 API 的容器,也是开发者订阅或购买你的 API 的最小单元。

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

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

使用场景

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

与已发布服务的关系

一个 API 产品可以由 API7 网关的多个已发布服务组成。但是,存在以下限制:

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

已发布服务与 API 产品之间的关系有助于明确开发团队内部的角色和职责。

工程师专注于技术方面:

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

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

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

这种关注点的分离可以实现更高效、更有效的 API 开发和管理。

更多资源