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

API 产品

你可以将 API7 门户(API7 Portal)视为展示高价值 API 的数字店面。其中,API 产品(API Products) 是针对特定需求和使用场景组织的一组 API。API7 门户通过 API 产品,以便于开发者理解、使用和管理的方式呈现 API。

概述

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

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

  • 从 API7 网关创建(推荐):API 产品基于 API7 网关服务(Service)创建,实现集中管理并简化向开发者交付 API 的流程。API7 门户为这些 API 产品提供订阅管理,并计划支持商业化能力。服务变更会自动反映到 API7 门户中关联的 API 产品,确保开发者及时看到最新内容。
  • 导入 OpenAPI:开发者可以在 API7 门户中浏览外部 API 定义,并在沙盒环境中与未托管在 API7 网关上的 API 交互。导入的 API 不支持身份认证、订阅和商业化等高级功能。

使用场景

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

与服务的关系

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

  • 一对一关联:一个服务只能关联到一个 API 产品。
  • 网关组限制:一个 API 产品中的服务必须来自同一个网关组。

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

工程师专注于技术方面:

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

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

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

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

更多资源