共享流软件包配置参考文档

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

共享流是可重复使用的功能,其类似于 API 代理。如果您已熟悉 API 代理,则您应该熟悉此参考文档的大部分内容。

如果您要了解如何构建共享流,请先从可重复使用的共享流主题开始。

共享流软件包结构

共享流软件包包含以下配置:

基本配置 主要配置设置。请参阅基本配置
政策 符合 Apigee Edge 政策架构的 XML 格式配置文件。请参阅政策
资源 政策引用以执行自定义逻辑的脚本、JAR 文件和 XSLT 文件。请参阅资源
SharedFlows 此软件包包含的共享流。请参阅共享流

上表中的组件由采用以下目录结构的配置文件定义:

共享流软件包的配置文件和目录结构

本部分介绍共享流软件包的配置文件和目录结构。

基本配置

基本配置文件位于软件包的根目录中。其名称是软件包的名称。

/sharedflowbundle/traffic-management-shared.xml

基本配置定义了共享流软件包的内容,以及用于跟踪软件包的修订历史记录的信息。

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

基本配置属性

名称 说明 默认 是否必需?
SharedFlowBundle
name 共享流软件包的名称,该名称在组织内必须独一无二。只能在名称中使用以下字符:A-Za-z0-9_- 不适用
revision 共享流软件包配置的修订版本号。您无需明确设置修订版本号,因为 Apigee Edge 会自动跟踪共享流的当前修订版本。 不适用

基本配置元素

名称 说明 默认 是否必需?
SharedFlowBundle
ConfigurationVersion 此共享流所遵守的共享流软件包配置架构的版本。目前唯一支持的值是 majorVersion 4 和 minorVersion 0。此设置将来可能会用于支持共享流软件包格式的演化。 4.0
CreatedAtCreatedBy 共享流软件包的创建日期/时间(以新纪元时间为单位),以及创建该软件包的用户的电子邮件。
Description 共享流的文本说明。如有提供,则说明将显示在 Edge 管理界面中。 不适用
DisplayName 易记的名称,可能与共享流配置的 name 属性不同。 不适用
LastModifiedAtLastModifiedBy 共享流软件包的最后一次修改日期/时间(以新纪元时间为单位),以及修改该软件包的用户的电子邮件。
Policies 此共享流的 /policies 目录中的政策列表。通常,只有在使用 Edge 管理界面创建共享流时,才会看到此元素。这只是一个“清单”设置,旨在让您深入了解共享流的内容。 不适用
Resources 此共享流的 /resources 目录中的资源(JavaScript、Python、Java、XSLT)的列表。通常,只有在使用 Edge 管理界面创建共享流时,才会看到此元素。这只是一个“清单”设置,旨在让您深入了解共享流的内容。 不适用
SharedFlows 指定此软件包包含的共享流。

请注意,此元素目前仅支持一个子级 <SharedFlow>。您只能在共享流软件包中添加一个共享流。

不适用

共享流

/sharedflowbundle/sharedflows/default.xml

SharedFlow 配置定义了流元素的执行顺序。每个 <SharedFlow> 元素的 <Step> 子元素都会指定序列的一部分(例如调用政策)。

以下 SharedFlow 配置指定了要按从上到下顺序执行的三项政策(在管理控制台中则为从左向右执行),其中先执行 Spike Arrest 政策,最后执行“流调出”政策

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

共享流配置属性

名称 说明 默认 是否必需?
SharedFlow
name 共享流的名称,该名称在组织内必须独一无二。只能在名称中使用以下字符:A-Za-z0-9_- 不适用
revision 共享流配置的修订版本号。您无需明确设置修订版本号,因为 Apigee Edge 会自动跟踪共享流的当前修订版本。 不适用

共享流配置元素

名称 说明 默认 是否必需?
SharedFlow 定义共享流中的政策序列。 不适用
Step 定义步骤 - 流序列中的阶段。 不适用
Name 指定步骤引用的项的名称。此元素的值应与该项的唯一标识符(例如政策的名称属性值)相同。 不适用

政策

/sharedflowbundle/policies

与在 API 代理中一样,在共享流软件包中,/policies 目录包含可用于附加到软件包中共享流的所有政策的配置 XML。政策会共享一部分元素,但这一部分元素补充了政策特有的元素。如需详细了解如何配置政策,请参阅与所需政策相关的主题。您也可以通过政策参考概览查看。

资源

/sharedflowbundle/resources

资源是可以使用政策附加到共享流的脚本、代码和 XSL 转换。它们显示在管理界面中共享流编辑器的“脚本”部分中。

如需了解支持的资源类型,请参阅资源文件

Apigee 开发者论坛中提出问题。