API 代理开发要点

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

本主题列出了 API 代理的一些基本特性,以及指向更多信息的链接。

API 是供一个应用使用另一个应用的功能的入口点。您可实现 API 代理来创建 API

在 Apigee Edge 中,您可以将 API 代理逻辑配置为响应客户端代码请求而执行的一系列步骤,从而实现 API 代理。通过定义包含资源路径、HTTP 动词、正文要求等的端点,您可以向客户端公开 API 代理。

虽然它被称为 API 代理,但从客户端代码的角度来看,它就是 API

如需大致了解 API 代理,请参阅了解 API 和 API 代理

您可使用流排列 API 代理逻辑的顺序

在任何应用中,数据都流经条件逻辑引导的应用。在 Apigee Edge 中,处理路径由流组成。流是一系列构成 API 代理的处理路径的阶段(或“步骤”)。流是 Apigee Edge 提供位置的方式,供您在特定位置(从客户端到后端资源再返回后端)应用逻辑和行为。

如需详细了解流,请参阅控制如何使用流执行代理

您可通过 API 代理创建的流变量访问状态数据

API 代理可以访问表示执行状态的变量。您可以通过配置 API 代理和政策的 XML 访问这些变量。此外,您还可以在使用过程语言(如 Java、JavaScript 或 Python)扩展 API 代理时访问这些代理。

这些变量由 Apigee Edge 保存。有些默认存在,通常是因为它们是 API 代理的通用功能(例如,因为它们是 HTTP 请求的一部分)。您还可以创建自己的变量以满足逻辑要求。

如需详细了解变量,请参阅使用流变量管理代理状态

您可以有条件地执行 API 代理

与大多数编程语言一样,您可以在 API 代理中有条件地执行代码。条件通常基于 API 代理状态(您可以通过流变量访问)。例如,您可以设置条件来检查是否有用户代理,然后相应地处理请求。

如需详细了解条件执行,请参阅流变量和条件

您可使用政策在 API 代理中实现大多数逻辑

您添加到 API 代理的大多数逻辑都以政策的形式打包。政策是 Apigee Edge 组件,用于封装功能区域(例如安全性或流量管理)的逻辑。您可以使用 XML 配置政策,以便为底层逻辑设置属性。您应在流中以一系列“步骤”排列政策,以便 API 代理以代理目标的最佳顺序执行逻辑。

如需详细了解政策,请参阅什么是政策?

您可以添加可重复使用的功能集

如果您的 API 代理包含将在代码中的多个位置(如其他 API 代理)中使用的逻辑,则您可以从多个位置针对调用收集该逻辑。例如,您可以将其他 API 代理调用的共享流中的安全逻辑分组,从而减少 API 代理中的重复。

如需详细了解共享流,请参阅可重复使用的共享流。如需详细了解 API 代理链接,请参阅将 API 代理链接到一起

您可以使用 Trace 工具调试代理

Apigee Edge 包含一个 Trace 工具,您可以使用该工具在调试和测试时检查 API 代理的执行流。该工具可直观地显示为请求执行的每个 API 代理步骤。与在调试程序中一样,您可以在每个步骤中查看构成 API 代理状态的变量值列表。

如需详细了解如何使用 Trace 进行调试,请参阅使用 Trace 工具

您可将 API 代理错误作为故障进行处理

通过配置故障处理程序,您可以自定义返回给 API 客户端的错误。通过故障处理程序,不管错误是来自您自己的代码还是来自其包含的组件(如政策),您都可以控制错误消息。

如需了解详情,请参阅处理故障