1. Homepage
  2. Flex Gateway (1.6)
  3. 内部ポリシーディレクトリ

  4. ヘッダーの挿入

ヘッダー挿入ポリシー

ポリシー名

ヘッダーの挿入

Summary (概要)

要求または応答にヘッダーを追加します。

カテゴリ

変換

使用可能な最小 Flex Gateway バージョン

v1.0.0

返される状況コード

500 - 評価されなかった式が設定に含まれる。

概要

ヘッダー挿入ポリシーでは、メッセージの要求または応答に HTTP ヘッダーが追加されます。API でこのポリシーを設定する場合、メッセージ処理に追加するヘッダーのインバウンドおよびアウトバウンドマップをキー-値ペアの形式で指定する必要があります。

header inject remove diagram

必要に応じて、ヘッダーの値または名前に DataWeave 式を含めることができます。この例では、設定されている次の式に一致するすべてのヘッダーがメッセージに挿入されます。

“#[attributes.requestPath]”

挿入されるヘッダーがすでにメッセージ属性に存在する場合、ポリシーは既存のヘッダーの値を上書きせずに新しいヘッダーを作成します。

複数の値のサポートは特定のヘッダーにのみ限定され、これらのヘッダーは設定された値を使用して上書きされます。これらのヘッダーは、​access-control-allow-origin​、​content-type​、​content-length​、​transfer-encoding​ です。

既存の他のメッセージヘッダーを上書きするには、ヘッダーを追加する前に既存のヘッダーを削除してください。​「ヘッダー削除​ポリシー」を参照してください。

ポリシーのパラメーターの設定

Flex Gateway のローカルモード

ローカルモードでは、宣言型の設定ファイルを使用してヘッダーの挿入ポリシーを API に適用します。以下のポリシー定義とパラメーターの表を参照してください。

- policyRef:
    name: header-injection-flex
  config:
    inboundHeaders: <array> // OPTIONAL, default: []
      - key: <string> // REQUIRED
        value: <string> // REQUIRED
    outboundHeaders: <array> // OPTIONAL, default: []
      - key: <string> // REQUIRED
        value: <string> // REQUIRED
パラメーター 必須または省略可能 デフォルト値 説明

inboundHeaders

省略可能

空の配列

メッセージ処理の最初に挿入されるヘッダーのリスト。

inboundHeaders.key

必須

なし

ヘッダー名の文字列または DataWeave 式

inboundHeaders.value

必須

なし

ヘッダー値の文字列または DataWeave 式

outboundHeaders

省略可能

空の配列

メッセージ処理の最後に挿入されるヘッダーのリスト。

outboundHeaders.key

必須

なし

ヘッダー名の文字列または DataWeave 式

outboundHeaders.value

必須

なし

ヘッダー値の文字列または DataWeave 式

inboundHeaders​ と ​outboundHeaders​ の両方を空にすることはできません。

リソースの設定例

次の例では、設定されている ​#[attributes.requestPath]​ 式に一致するすべてのヘッダーがメッセージに挿入されます。

- policyRef:
    name: header-injection-flex
    config:
      inboundHeaders:
        - key: "new-inbound-header"
          value: "#[attributes.requestPath]"
      outboundHeaders:
        - key: "new-outbound-header"
          value: "#[attributes.requestPath]"

Flex Gateway の接続モード

UI からポリシーを API に適用するときに、以下のパラメーターが表示されます。

パラメーター 説明

Inbound Header Map (インバウンドヘッダーマップ)

メッセージ処理の最初に挿入されるヘッダーのリスト。

インバウンドヘッダーキー

メッセージの先頭でヘッダー名として使用する文字列または DataWeave 式。

インバウンドヘッダー値

メッセージの先頭でヘッダー値として使用する文字列または DataWeave 式。

Outbound Header Map (アウトバウンドヘッダーマップ)

メッセージ処理の最後に挿入されるヘッダーのリスト。

アウトバウンドヘッダーキー

メッセージ処理の最後にヘッダー名使用する文字列または DataWeave 式。

アウトバウンドヘッダー値

メッセージ処理の最後にヘッダー値として使用する文字列または DataWeave 式。

Method & Resource conditions (メソッドとリソースの条件)

API の一部またはすべてのメソッドおよびリソースに設定を追加するオプション

ヘッダーキーは、 HTTP 1.1​ 標準に準拠している必要があります。