Request Validator Configuration

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

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

構成

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

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は request-validator 。

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

• instance_name

  string

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

    string

    The request body schema specification. One of body_schema or parameter_schema must be specified.

  • allowed_content_types

    set of type string default: application/json

    List of allowed content types. The value can be configured with the charset parameter. For example, application/json; charset=UTF-8.

  • version

    string required default: kong Must be one of: kong, draft4

    Which validator to use. Supported values are kong (default) for using Kong’s own schema validator, or draft4 for using a JSON Schema Draft 4-compliant validator.

  • parameter_schema

    array of type record

    Array of parameter validator specification. One of body_schema or parameter_schema must be specified.

    • in

      string required Must be one of: query, header, path

      The location of the parameter.

    • name

      string required

      The name of the parameter. Parameter names are case-sensitive, and correspond to the parameter name used by the in property. If in is path, the name field MUST correspond to the named capture group from the configured route.

    • required

      boolean required

      Determines whether this parameter is mandatory.

    • style

      string Must be one of: label, form, matrix, simple, spaceDelimited, pipeDelimited, deepObject

      Required when schema and explode are set. Describes how the parameter value will be deserialized depending on the type of the parameter value.

    • explode

      boolean

      Required when schema and style are set. When explode is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters, this property has no effect.

    • schema

      string

      Requred when style and explode are set. This is the schema defining the type used for the parameter. It is validated using draft4 for JSON Schema draft 4 compliant validator. In addition to being a valid JSON Schema, the parameter schema MUST have a top-level type property to enable proper deserialization before validating.

  • verbose_response

    boolean required default: false

    If enabled, the plugin returns more verbose and detailed validation errors.