Response Transformer Configuration

このページは、まだ日本語ではご利用いただけません。翻訳中です。

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

Response Transformerプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

• name or plugin

  string required

  プラグイン名。この場合は response-transformer 。

  • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
  • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: response-transformer_my-service 。

  インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。

  インスタンス名は、次のコンテキスト内で一意である必要があります。

  • Kong Gateway Enterpriseのワークスペース内
  • Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
  • Kong Gateway (OSS)の全世界

• service.name or service.id

  string

  プラグインが対象とするサービス名または ID。最上位の /plugins エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください /services/{serviceName|Id}/plugins を使用する場合は必要ありません。

• route.name or route.id

  string

  プラグインがターゲットとするルート名または ID。最上位の /plugins エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください /routes/{routeName|Id}/plugins を使用する場合は必要ありません。

• consumer.name or consumer.id

  string

  プラグインがターゲットとするコンシューマーの名前または ID。 最上位の /plugins エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください /consumers/{consumerName|Id}/pluginsを使用する場合は必要ありません。

• enabled

  boolean default: true

  このプラグインが適用されるかどうか。

• config

  record required
  • remove

    record required
    • json

      array of type string required

      List of property names. Remove the property from the JSON body if it is present.

    • headers

      array of type string required

      List of header names. Unset the header(s) with the given name.

  • rename

    record required
    • headers

      array of type string required

      List of original_header_name:new_header_name pairs. If the header original_headername is already set, rename it to new_headername. Ignored if the header is not already set.

  • replace

    record required
    • json

      array of type string required

      List of property:value pairs. If and only if the parameter is already present, replace its old value with the new one. Ignored if the parameter is not already present.

    • json_types

      array of type string required Must be one of: boolean, number, string

      List of JSON type names. Specify the types of the JSON values returned when replacing JSON properties. Each string element can be one of: boolean, number, or string.

    • headers

      array of type string required

      List of headername:value pairs. If and only if the header is already set, replace its old value with the new one. Ignored if the header is not already set.

  • add

    record required
    • json

      array of type string required

      List of property:value pairs. If and only if the property is not present, add a new property with the given value to the JSON body. Ignored if the property is already present.

    • json_types

      array of type string required Must be one of: boolean, number, string

      List of JSON type names. Specify the types of the JSON values returned when adding a new JSON property. Each string element can be one of: boolean, number, or string.

    • headers

      array of type string required

      List of headername:value pairs. If and only if the header is not already set, set a new header with the given value. Ignored if the header is already set.

  • append

    record required
    • json

      array of type string required

      List of property:value pairs. If the property is not present in the JSON body, add it with the given value. If it is already present, the two values (old and new) will be aggregated in an array.

    • json_types

      array of type string required Must be one of: boolean, number, string

      List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.

    • headers

      array of type string required

      List of headername:value pairs. If the header is not set, set it with the given value. If it is already set, a new header with the same name and the new value will be set. Each string element can be one of: boolean, number, or string.