OAS Validator | APISIX & API7 API Gateway Docs

Parameters

See plugin common configurations for configuration options available to all plugins.

spec
string
required
String containing the Open API spec.
verbose_errors
boolean
default: false
If true, respond with detailed error if the validation fails.
skip_request_body_validation
boolean
default: false
If true, skip the validation of request body.
skip_request_header_validation
boolean
default: false
If true, skip the validation of request header.
skip_query_params_validation
boolean
default: false
If true, skip the validation of query parameters.
skip_path_params_validation
boolean
default: false
If true, skip the validation of path parameters.
reject_if_not_match
boolean
default: true
If false, requests that fail OAS validation are logged as error but the request is still forwarded to the upstream service.
Available in API7 Enterprise from 3.9.6 and not in APISIX.
rejection_status_code
integer
default: 400
vaild vaule:
400–599
HTTP status code to return when request validation fails. For example, set to 422 to distinguish semantic validation errors (Unprocessable Entity) from malformed request syntax (400 Bad Request). Only effective when reject_if_not_match is true.
Available in API7 Enterprise from version 3.9.8. Not available in APISIX yet.