API 管理策略

• 09/18/2017
• 作者
  • 

本部分提供以下 API 管理策略的参考。 有关添加和配置策略的信息，请参阅 API 管理中的策略。

策略是一项强大的系统功能，允许发布者通过配置更改 API 的行为。 策略是一组语句，在请求或响应 API 时按顺序执行。 常用的语句包括从 XML 到 JSON 的格式转换，并调用速率限制来限制从一名开发人员传入的调用量。 许多策略开箱即用。

在任何 API 管理策略中，策略表达式可以用作属性值或文本值，除非该策略另外指定。 某些策略（如控制流和设置变量策略）基于策略表达式。 有关详细信息，请参阅高级策略和策略表达式。

策略

• 访问限制策略

  • 检查 HTTP 标头 - 必须存在 HTTP 标头和/或强制采用 HTTP 标头的值。

  • 按订阅限制调用速率 - 根据订阅限制调用速率，避免 API 使用量暴增。

  • 按密钥限制调用率 - 根据密钥限制调用率以避免 API 使用量暴增。

  • 限制调用方 IP - 筛选（允许/拒绝）来自特定 IP 地址和/或地址范围的调用。

  • 按订阅设置使用量配额 - 允许根据订阅强制实施可续订或有生存期的调用量和/或带宽配额。

  • 按密钥设置使用量配额 - 允许根据密钥强制实施可续订或有生存期的调用量和/或带宽配额。

  • 验证 JWT - 强制从指定 HTTP 标头或指定查询参数提取的 JWT 必须存在且有效。

• 高级策略

  • 控制流 - 根据布尔表达式的求值，有条件地应用策略语句。

  • 转发请求 - 将请求转发到后端服务。

  • 记录到事件中心 - 将指定格式的消息发送到记录器实体定义的消息目标。

  • 重试 - 重试执行括住的策略语句，直到符合条件为止。 系统会按指定的时间间隔重复执行，直到达到指定的重试计数为止。

  • 返回响应 - 中止管道执行，将指定的响应直接返回给调用方。

  • 发送单向请求 - 将请求发送到指定的 URL，无需等待响应。

  • 发送请求 - 将请求发送到指定的 URL。

  • 设置变量 - 保存命名上下文变量中的值供以后访问。

  • 设置请求方法 - 允许更改请求的 HTTP 方法。

  • 设置状态代码 - 将 HTTP 状态代码更改为指定的值。

  • 跟踪 - 将字符串添加到 API 检查器输出中。

  • 等待 - 继续之前，等待括住的发送请求、从缓存中获取值或控制流策略完成。

• 身份验证策略

  • 使用基本方法进行身份验证 - 使用基本身份验证方法向后端服务进行身份验证。

  • 使用客户端证书进行身份验证 - 使用客户端证书向后端服务进行身份验证。

• 缓存策略

  • 从缓存中获取 - 执行缓存查找，并返回有效的缓存响应（如果有）。

  • 存储到缓存 - 根据指定的缓存控制配置来缓存响应。

  • 从缓存中获取值 - 按密钥检索缓存项。

  • 在缓存中存储值 - 按密钥在缓存中存储项。

  • 从缓存中删除值 - 按密钥在缓存中删除项。

• 跨域策略

  • 允许跨域调用 - 使 API 能够通过 Adobe Flash 和基于 Microsoft Silverlight 浏览器的客户端进行访问。

  • CORS - 向操作或 API 添加跨源资源共享 (CORS) 支持，允许从基于浏览器的客户端进行跨域调用。

  • JSONP - 向操作或 API 添加填充型 JSON (JSONP) 支持，以便从基于 JavaScript 浏览器的客户端执行跨域调用。

• 转换策略

  • 将 JSON 转换为 XML - 将请求或响应正文从 JSON 转换为 XML。

  • 将 XML 转换为 JSON - 将请求或响应正文从 XML 转换为 JSON。

  • 查找并替换正文中的字符串 - 查找请求或响应子字符串，并将其替换为不同的子字符串。

  • 在内容中屏蔽 URL - 重写（屏蔽）响应正文中的链接，使其通过网关指向等效的链接。

  • 设置后端服务 - 更改传入请求的后端服务。

  • 设置正文 - 设置传入和传出请求的消息正文。

  • 设置 HTTP 标头 - 向现有的响应和/或请求标头赋值，或者添加新的响应和/或请求标头。

  • 设置查询字符串参数 - 添加、删除请求查询字符串参数或替换其值。

  • 重写 URI - 将请求 URL 从其公用格式转换为 Web 服务所需的格式。

  • 使用 XSLT 转换 XML - 在请求或响应正文中的 XML 应用 XSL 转换。

后续步骤

有关如何使用策略的详细信息，请参阅 API 管理中的策略。