使用政策添加功能

本页面适用于 ApigeeApigee Hybrid

查看 Apigee Edge 文档。

借助 Apigee,您可以使用政策对 API 行为进行编程,而无需编写任何代码。政策就像一个实现特定受限管理功能的模块。 这些政策旨在让您能够高效可靠地向 API 添加常见类型的管理功能。

政策提供安全、速率限制、转换和中介功能等功能,让您无需自行构建和维护代码。不限于 Apigee 提供的一组政策类型。您还可以编写自定义脚本和代码(例如 JavaScript 应用),它们能够扩展 API 代理功能,让您在 Apigee 政策支持的基本管理功能的基础上创新。

按照以下部分中的说明,使用 Apigee in Cloud Code 创建政策并将其附加到 API 代理和共享流。根据政策类型,您可能需要创建资源,如管理资源中所述。另请参阅管理 Apigee 工作区中的文件夹和文件

创建政策

如需使用 Apigee in Cloud Code 创建政策,请执行以下操作:

  1. 在 Apigee 工作区中,根据要附加政策的位置执行以下操作之一:

    附加到 操作
    API 代理 执行以下操作之一:
    • 将光标放在以下其中一个文件夹上,点击 “创建 Apigee 政策”图标,然后选择创建政策
      • apiproxy-name 代理软件包
      • apiproxy-name/apiproxy
    • 将光标放在 API 代理的 apiproxy-name/apiproxy/policies 文件夹上,然后点击 “创建 API 代理”图标
    共享流 执行以下操作之一:
    • 将光标放在以下其中一个文件夹上,点击 “创建共享流”图标,然后选择创建政策
      • sharedflow-name 共享流软件包
      • sharedflow-name/sharedflowbundle
    • 将光标放在共享流的 sharedflow-name/sharedflowbundle/policies 文件夹上,然后点击 “创建共享流”图标

此时 Create policy 向导会打开。

  1. 从列表中选择要创建的政策的类别。 如需了解政策类别,请参阅政策参考概览

  2. 输入政策的唯一名称,然后按 Enter 键。该政策会添加到 Apigee 部分中 API 代理或共享流的 /policies 文件夹中,并在编辑器中打开。

  3. 根据需要修改文件,然后选择 File > Save 或 ⌘S 保存修改。 如需详细了解如何配置政策,请参阅政策参考概览

  4. 根据政策类型创建资源,如管理资源中所述。

将政策附加到流

政策在附加到流之前不会执行。通过将 <Step> 元素添加到 ProxyEndpoint 或 TargetEndpoint 配置中的相应请求或响应流元素,可以将政策附加到流,如以下主题所述:

例如,以下配置将 QuotaPolicy 附加到 ProxyEndpoint 的 <PreFlow>,用于配置 API 代理在一段时间内允许的请求消息数。

<ProxyEndpoint name="default">
  <PreFlow>
    <Request>
      <Step><Name>QuotaPolicy</Name></Step>
    </Request>
  </PreFlow>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
  </HTTPProxyConnection>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>