API プロパティー

このプロパティーは、 DataPower® Gateway (v5 compatible)でのみサポートされます。 DataPower API Gateway を使用している場合、同じ機能を実現するには、以下の例のように、API の OpenAPI 定義の invoke ポリシー構成に header-control プロパティーを追加します。

- 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です。

デフォルト値は falseです。

デフォルト値は falseです。

• all: 空の子配列を含む、すべての空の配列を出力します。 プロパティーが構成されていないか、プロパティーの値が無効な場合、これがデフォルト値です。
• parent: 現在のプロパティーの空の配列値のみを出力します。 このプロパティーの子マップ・アクションは試行されません。
• none: 空の出力配列値が生成されないようにします。

参照される定義がスキーマの値として提供されると、map ポリシーはスキーマを API 定義から作成します。 スキーマに循環参照を生成する参照が含まれていない場合、このプロパティーを true に設定すると、そうでない場合に生成されるスキーマと同じスキーマを生成する際にパフォーマンス上の利点が得られる可能性があります。 ただし、スキーマが非常に複雑で、多数の循環参照が存在する可能性がある場合は、生成されるスキーマは異なる可能性があります。これは、拡張スキーマ処理では循環参照が異なる方法で処理されるためです。 このような場合、生成された出力を調べて、パフォーマンス上の利点を得た代わりに map ポリシーの出力に変更が生じていないかを確認する必要があります。

このプロパティーのデフォルト値は false で、既存の動作とパフォーマンスが維持されます。

デフォルト値は falseです。

• string: 空の XML エレメントの値が空のストリングとして扱われます。 プロパティーが構成されていないか、プロパティーの値が無効な場合、これがデフォルト値です。
• null: 空の XML エレメントの値が null として扱われます。 API プロパティー x-ibm-gateway-map-null-value にも値 true が設定されていなければ、このエレメントが JSON 出力プロパティーにマップされることはありません。
• none: 空の XML エレメントが無視されます。
• string-badgerfish: 空の XML エレメントの値が空のストリングとして扱われます。 空ストリング値は、JSON BadgerFish 値プロパティーに入れられます。
• null-badgerfish: 空の XML エレメントの値が null として扱われます。 ヌル値は、JSON BadgerFish 値プロパティーに入れられます。 API プロパティー x-ibm-gateway-map-null-value にも値 true が設定されていなければ、このエレメントが JSON 出力プロパティーにマップされることはありません。

デフォルト値は 1 です。この場合、循環スキーマ定義をたどって反復処理することはありません。 可能な最大値は 5 です。 5 より大きい値を指定すると、値 5 が想定されます。 数値でない値を指定した場合は、1 の値が想定されます。

• 配列が、1 つ以上の必須プロパティーが含まれているオブジェクトで構成されている。
• オプションであるオブジェクトに、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 が指定されていない場合、これらの必須プロパティーは、デフォルト値を使用して出力で作成されません。

デフォルト値は falseです。

このプロパティーは、 DataPower Gateway (v5 compatible)でのみサポートされます。 DataPower API Gateway を使用している場合、同じ機能を実現するには、以下の例のように、API の OpenAPI 定義の invoke ポリシー構成に header-control プロパティーを追加します。

- 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です。

このプロパティーは、API 要求ペイロードに適用され、x-ibm-gateway-api-enforce-response-limits が有効な場合は API 応答ペイロードに適用されます。

• default: ヘッダー値で、これらの文字を検査しません。 存在する場合、API 要求は「HTTP 500 Internal Server Error」で失敗します。
• sanitize: ヘッダー値内の不正な XML 文字が、? 文字に置き換わります。 API 処理は続行します。 request.headers.<headername> を読み取ろうとする API には、値内の ? 文字が表示されます。 しかし、message.headers の表示元のプロトコル・ヘッダーには元の文字が残っており、それが呼び出しサーバーやプロキシー・バックエンド・サーバーに送信されます。
• bad-request: ヘッダー値で、これらの文字を検査します。 存在する場合、API 要求は「HTTP 400 Bad Request」で失敗します。

デフォルト値は defaultです。