OAS Validation設定

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

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

構成

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

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は oas-validation 。

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

• instance_name

  string

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

    string required

    The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.

  • verbose_response

    boolean default: false

    If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

  • validate_request_body

    boolean default: true

    If set to true, validates the request body content against the API specification.

  • notify_only_request_validation_failure

    boolean default: false

    If set to true, notifications via event hooks are enabled, but request based validation failures don’t affect the request flow.

  • validate_request_header_params

    boolean default: true

    If set to true, validates HTTP header parameters against the API specification.

  • validate_request_query_params

    boolean default: true

    If set to true, validates query parameters against the API specification.

  • validate_request_uri_params

    boolean default: true

    If set to true, validates URI parameters in the request against the API specification.

  • validate_response_body

    boolean default: false

    If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.

  • notify_only_response_body_validation_failure

    boolean default: false

    If set to true, notifications via event hooks are enabled, but response validation failures don’t affect the response flow.

  • query_parameter_check

    boolean required default: false

    If set to true, checks if query parameters in the request exist in the API specification.

  • header_parameter_check

    boolean required default: false

    If set to true, checks if HTTP header parameters in the request exist in the API specification.

  • allowed_header_parameters

    string default: Host,Content-Type,User-Agent,Accept,Content-Length

    List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.

  • include_base_path

    boolean required default: false

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

  • api_spec_encoded

    boolean required default: true

    Indicates whether the api_spec is URI-Encoded.