基本术语

您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
信息

其中有几项在 Apigee 中具有独特意义的常见概念。

术语 定义
API

“应用编程接口”—可以让应用轻松“使用”来自其他应用的功能或数据的接口。

通过定义稳定且简化的应用逻辑和数据入口点,API 可让开发者轻松访问和重复使用其他开发者构建的应用逻辑。对于 Web APIs,这些逻辑和数据会通过网络公开。由于使用 API 的应用对更改很敏感,因此 API 还暗含一则合同。此合同提供一定程度的保证,即随着时间的推移,API 会以可预测的方式发生变化。

Apigee 提供了有关 API 的丰富信息,以及开发和使用 API 的最佳做法。若要开始设计,请观看 API 设计网络广播,或下载免费电子书 Web API 设计:开发者钟爱的界面的缺失链接最佳实践

API 代理

Edge 上的一个或多个 API、通用 HTTP 服务或应用(例如 Node.js)的外观。

API 代理被实现为一组配置文件、政策和代码,这些内容依赖于 Apigee Edge 提供的一组资源。您可以使用 Apigee Edge 管理界面生成和配置 API 代理,也可以在文本编辑器或 IDE 中本地实现 API 代理。

API 代理提供的表层将面向开发者的 API 与“后端”服务分离,从而保护开发者免受代码更改的影响,并在不会影响内部开发团队的情况下在边缘实现创新。开发团队对后端进行更改时,开发者可以持续调用同一个接口。借助 Apigee,您可以向同一 API 公开多个接口、自定义 API 签名,从而同时满足不同定位的开发者的需求。

API 基本路径和资源

由网络地址和 URI 定义的 API。一个 API 由“基本路径”和一组“API 资源”组成。每个 API 代理都定义了一个基本路径,以及多个 API 资源路径(可选)。您可以将 API 简单地视为一组 URI,所有 URI 共用一个基本路径。

为了让您更轻松地管理 API,Apigee 使用显示名和描述来增强这些原始 URI。Edge 允许您将政策和代码附加到 URI,从而对 API 的行为进行精细控制和管理。

API 产品

与配额或服务计划相结合的 API 资源 (URI) 的集合,将在设计时发布给应用开发者。然后,API 产品可以捆绑到 API 套餐中,以供获利。

一个 API 密钥与一个或多个 API 产品绑定,从而强制绑定应用与应用获准使用的 URI。

API 套餐 一组 API 产品,它们以软件包形式提供给开发者,通常与“获利策略”中定义的一项费率方案相关。
app

application 的缩写。app 一词指的是使用 API 的移动应用。开发者借助各种技术和平台,并使用各种编程语言来实现应用。想要使用 API 的开发者可以在 Apigee Edge 上的 API 提供商组织中注册应用。

注册应用时,Apigee 会生成用于识别应用的 API 密钥和 Secret。开发者将 API 密钥嵌入到应用中,随后会在发出请求时显示该密钥。API 服务通过直接的 API 密钥验证或 OAuth 实现 API 密钥的安全性。

环境

API 代理的运行时执行上下文。API 代理必须先部署到环境,然后才能通过网络访问其公开的 API。默认情况下,组织预配有两个环境:“测试”和“生产”。

  • “测试”环境通常用于在开发期间部署 API 代理。
  • “生产”环境通常用于在完全开发和测试后,从测试环境中推广 API 代理。
组织

容纳 Apigee Edge 账户中所有对象的容器,包括 API 代理、API 产品、API 套餐、应用和开发者。

您加入的每个组织都需要一个用户账号。(大多数用户只能在一个组织中拥有一个账号。)

政策

一项处理步骤,作为 API 代理处理流程中可重复使用的原子化逻辑单元执行。

基于政策的典型功能包括转换消息格式、强制执行访问权限控制、调用远程服务来获取更多信息、遮盖外部用户的敏感数据、检查消息内容以确定是否存在潜在的威胁、缓存常见响应以提高性能等。

可以根据请求或响应消息的内容或上下文有条件地执行政策。例如,如果请求消息从智能手机发出,则可以执行转换政策以自定义响应格式。

API 资源路径 RESTful 概念,资源路径是对访问给定资源的网络路径进行标识的统一资源标识符 (URI)。
版本

面向开发者的 API 接口版本。

例如 pivotaltracker.com/services/v3api.enterprise.apigee.com/v1

应将该术语与“修订版本”加以区分,后者是捆绑到 API 代理中已编号且受版本控制的配置和策略软件包。API 接口有版本;API 代理有修订版本。

修订版本 捆绑到 API 代理中已编号且受版本控制的配置和策略软件包。应将该术语与“版本”加以区分,后者是面向开发者的 API 接口。请参阅上述“版本”内容。