您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息
借助 Apigee Edge,您可以使用“政策”对 API 行为进行“编程”的编程,而无需编写任何代码。政策就像一个实现特定受限管理功能的模块。这些政策旨在让您能够轻松可靠地向 API 添加常见的管理功能类型。政策提供安全、速率限制、转换和中介功能等功能,让您无需自行编写代码和维护此功能。
您可以使用的不只有 Apigee Edge 提供的一组政策类型。您还可以编写自定义脚本和代码(例如 JavaScript 和 Node.js 应用),以扩展 API 代理功能,并在 Apigee 政策支持的基本管理功能的基础上创新。
请观看本视频,了解政策附件和执行。
政策类型
从技术上讲,政策是 XML 格式的配置文件。每种政策类型的结构(例如必需和可选的配置元素)均由 XML 架构定义。如果您精通 XML 工具,不妨在 GitHub 上的 API 平台示例中熟悉一下政策架构。
边缘政策类型分为以下功能类别:
流量管理
通过流量管理类别中的政策,您可以通过 API 代理控制请求和响应消息的流。这些政策同时支持操作级和业务级控制。它们可让您控制原始吞吐量,还可以按应用控制流量。通过流量管理政策类型,您可以强制执行配额,还有助于减轻拒绝服务攻击的风险。
安全性
安全类别中的政策支持身份验证、授权以及基于内容的安全措施。
中介
中介类别中的政策让您可以在消息流经 API 代理时主动对其执行操作。它们允许您将消息格式从 XML 转换为 JSON(反之亦然),或将一种 XML 格式转换为另一种 XML 格式。它们还可让您解析消息、生成新消息和更改出站消息的值。中介政策还与 API 服务公开的基本服务进行交互,让您可以在运行时检索有关应用、开发者、安全令牌和 API 产品的数据。
扩展程序
通过扩展程序类别中的政策,您可以利用 API 服务的可扩展性,从而以您选择的编程语言实现自定义行为。
政策参考文档概览中详细介绍了每种政策类型。本主题演示了常规交互,说明如何创建政策,以及如何将它们附加到 API 代理配置中的数据流。
部署政策更改
要使政策更改生效,您必须将 API 代理修订版本部署到环境。附加政策或对现有政策进行更改后,请使用管理界面或 Management API 部署更改。
验证政策执行情况
要验证政策是否正确执行,API 必须由 HTTP 客户端调用。如需验证此配额配置,请向 API 提交多个请求,超出您在配额政策中设置的配额限制。(下面请求中的 URI 路径(配置为 ProxyEndpoint 中的基本路径设置)是 /weather
)。
http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282
在一分钟内提交多个请求后,您应该会看到以下错误消息:
{ "fault":{ "faultstring":"policies.ratelimit.QuotaViolation", "detail":{ "errorcode":"policies.ratelimit.QuotaViolation" } } }
这表示配额政策正在由 API 服务强制执行。
基于政策的错误处理
请记下以上错误消息的格式。它包含 faultstring
属性和 errorcode
属性。在许多情况下,您需要实现某些处理这些错误的行为。例如,您可能希望向应用超出配额的开发者发布自定义消息。
如需详细了解错误处理,请参阅处理错误。
最佳做法:常见政策集
为了满足基本管理要求,API 代理通常会强制执行以下政策:
基本 API 密钥验证
ProxyEndpoint 请求流程:- SpikeArrest
- XMLThreatProtection 或 JSONThreatProtection
- API 密钥验证
- 配额
- ResponseCache
- ResponseCache
基本转换:JSON 到 XML
请求流程:- SpikeArrest
- JSONThreatProtection
- API 密钥验证
- 配额
- JSONtoXML
- XMLtoJSON
- ResponseCache