API 属性

此属性仅受 DataPower® Gateway（与 v5 兼容） 支持。如果使用的是 DataPower API Gateway，那么，要实现相同的功能，请将 header-control 属性添加到您的 API 的 OpenAPI 定义中的 invoke 策略配置中，如以下示例所示。

- invoke:
    target-url: http://myhostname/mypath
    header-control:
        type: blacklist
        values:
            - ^X-Client-ID$

- invoke:
    target-url: http://myhostname/mypath
    parameter-control:
        type: blacklist
        values:
            - ^userId$

缺省值为 false。

缺省值为 false。

• all：输出所有空数组，包括空的子代数组。如果此属性未配置或具有无效值，那么这是缺省值。
• parent：仅输出当前属性的空数组值。不会尝试此属性的子代映射操作。
• none：防止生成任何空输出数组值。

当引用的定义作为模式的值提供时，映射策略将从 API 定义构建模式。如果该模式没有生成循环引用的引用，那么将此属性设置为 true 可能会在生成某些已经生成的相同模式时提供性能优势。但是，在模式非常复杂（具有许多潜在循环引用）的情况下，生成的模式可能有所不同，因为增强的模式处理以不同方式处理循环引用。因此，在这种情况下，您应检查生成的输出以确定所获得的性能优势是否与映射策略输出中的更改无关。

此属性的缺省值是 false，用于维持现有的行为和性能。

缺省值为 false。

• string：空 XML 元素的值被视为空字符串。 如果此属性未配置或具有无效值，那么这是缺省值。
• null：空 XML 元素的值被视为空值。除非同时为 API 属性 x-ibm-gateway-map-null-value 指定值 true，否则不会将此元素映射到 JSON 输出属性。
• none：忽略空 XML 元素。

缺省值为 1，这意味着不遵循循环模式定义。最大可能值为 5。如果指定大于 5 的整数值，那么假定值为 5。如果指定非数字值，那么将假定值为 1。

• 数组由包含一个或多个必需属性的对象组成。
• 可选的对象具有一个或多个必需的子属性。

缺省情况下，输出中不存在这些必需属性。如果将 x-ibm-gateway-map-emulate-v4-default-required-properties API 属性设置为 true，那么这些必需属性将显示在输出中。如果输出模式定义了输出属性的 default 属性，那么将使用指定的缺省值，否则将根据数据类型来分配缺省值，如下所示：

• 字符串：空字符串 ("")
• 数字：0
• 布尔：false
• 对象：空对象
• 数组：空数组

如果未指定 x-ibm-gateway-map-emulate-v4-default-required-properties API 属性或者值不是 true，那么不会在输出中使用其缺省值来创建这些必需属性。

此属性仅受 DataPower Gateway（与 v5 兼容） 支持。如果使用的是 DataPower API Gateway，那么，要实现相同的功能，请将 header-control 属性添加到您的 API 的 OpenAPI 定义中的 invoke 策略配置中，如以下示例所示。

- proxy:
    target-url: http://myhostname/mypath
    header-control:
        type: blacklist
        values:
            - ^X-Client-ID$

- proxy:
    target-url: http://myhostname/mypath
    parameter-control:
        type: blacklist
        values:
            - ^userId$

缺省值为 false。

缺省值为 true。

缺省值为 false。