了解 API 和 API 代理

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档
信息

借助 Apigee Edge,您可以轻松、快速构建可供应用开发者使用的 RESTful API。通过构建充当后端服务托管“Facade”的 API 代理,可在 Edge 上公开 API。本主题讨论 Apigee Edge 上 API 与 API 代理之间的关系。

视频:观看此视频短片,了解 API 代理。

什么是 API?

API 是可以让应用轻松“使用”来自其他应用的功能或数据的接口。通过定义稳定且简化的应用逻辑和数据入口点,API 可让开发者轻松访问和重复使用其他开发者构建的应用逻辑。对于“Web API”,这些逻辑和数据会通过网络公开。

由于使用 API 的应用对更改很敏感,因此 API 还暗含一则“合同”。此合同提供一定程度的保证,即随着时间的推移,API 会以可预测的方式发生变化。

借助 Apigee Edge,您可以构建 API;如果您已经拥有 API,则直接公开这些 API,同时添加管理和可见性层。如果您有启用 HTTP 的服务(例如基于 SOA 的网络服务),则这些服务也可以通过 Apigee Edge 作为 API 公开。

此外,借助 Edge,您还可实现 API 服务平台上托管的应用,而无需相关后端服务,从而构建 API。您可以使用 JavaScript、Java 和 Node.js 构建这些应用。

什么是 API 代理?

您可以通过实现 API 代理在 Apigee Edge 上公开 API。API 代理将面向应用的 API 与后端服务分离,从而保护这些应用免受后端代码更改的影响。当您对服务进行后端更改时,应用会继续调用相同的 API,而不会中断。

API 代理配置中有两种类型的端点:

  • ProxyEndpoint:定义客户端应用使用您的 API 的方式。您可配置 ProxyEndpoint 来定义 API 代理的网址。代理端点还确定应用是通过 HTTP 还是 HTTPS 访问 API 代理。通常情况下,您可以将政策附加到 ProxyEndpoint 以强制执行安全性、配额检查,以及其他类型的访问权限控制和速率限制。
  • TargetEndpoint:定义 API 代理与后端服务互动的方式。您可配置 TargetEndpoint 以将请求转发到正确的后端服务,包括定义任何安全设置、HTTP 或 HTTPS 协议以及其他连接信息。您可以将政策附加到 TargetEndpoint,以确保针对发出初始请求的应用设置正确的响应消息格式。

如下图所示,您可以直观呈现 API 代理:

HTTP 请求通过代理请求端点进入,传递到目标请求端点,然后发送到后端服务。HTTP 响应通过目标响应端点进入,传递到代理响应端点,然后返回客户端。

如何创建 API 代理?

API 代理由一组 XML 配置文件和代码(例如 JavaScript 和 Java)组成。Apigee 为您提供了几种创建 API 代理的方法,其中包括:

  • 使用 Edge 管理界面在图形界面 (GUI) 中定义 API 代理。 如需了解详情,请参阅构建简单的 API 代理
  • 创建 XML 文件以及任何其他支持文件来定义 API 代理,然后将其导入 Edge。
  • 使用 Edge 管理 API 向 Edge 发出一系列 REST 请求以创建 API 代理。
  • 将 Node.js 应用部署为代理。请参阅部署独立的 Node.js 应用

什么是政策?

借助 Edge,您可以使用政策控制 API 行为,而无需编写任何代码。policies在代理请求/响应流中,政策就像一个实现特定受限管理功能的模块。这些政策旨在让您能够轻松可靠地向 API 添加常见的管理功能类型。政策提供安全、速率限制、转换和中介功能等功能,让您无需自行编写代码和维护此功能。

创建您的第一个 API 代理

Apigee 提供了一系列教程,您可以使用这些教程来创建第一个 API。从构建您的第一个 API 代理开始。

如需了解 API 代理,不妨按照使用 API 代理示例中所述的方法操作。

了解详情