Mocking設定

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

構成

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

Use the api_specification config for DB-less or hybrid mode. The API spec is configured directly in the plugin.

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は mocking 。

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: mocking_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
  • api_specification_filename

    string

    The path and name of the specification file loaded into Kong Gateway’s database. You cannot use this option for DB-less or hybrid mode.

  • api_specification

    string

    The contents of the specification file. You must use this option for hybrid or DB-less mode. You can include the full specification as part of the configuration. In Kong Manager, you can copy and paste the contents of the spec directly into the Config.Api Specification text field.

  • random_delay

    boolean default: false

    Enables a random delay in the mocked response. Introduces delays to simulate real-time response times by APIs.

  • max_delay_time

    number default: 1

    The maximum value in seconds of delay time. Set this value when random_delay is enabled and you want to adjust the default. The value must be greater than the min_delay_time.

  • min_delay_time

    number default: 0.001

    The minimum value in seconds of delay time. Set this value when random_delay is enabled and you want to adjust the default. The value must be less than the max_delay_time.

  • random_examples

    boolean default: false

    Randomly selects one example and returns it. This parameter requires the spec to have multiple examples configured.

  • included_status_codes

    array of type integer

    A global list of the HTTP status codes that can only be selected and returned.

  • random_status_code

    boolean required default: false

    Determines whether to randomly select an HTTP status code from the responses of the corresponding API method. The default value is false, which means the minimum HTTP status code is always selected and returned.

  • include_base_path

    boolean required default: false

    Indicates whether to include the base path when performing path match evaluation.

  • custom_base_path

    string starts_with: /

    The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.