跳到主要内容

参数

请参阅 插件通用配置 了解所有插件可用的配置选项。

  • spec

    string


    required


    包含 Open API 规范的字符串。

  • verbose_errors

    boolean


    default: false


    如果为 true,则在验证失败时响应详细错误。

  • skip_request_body_validation

    boolean


    default: false


    如果为 true,则跳过请求体验证。

  • skip_request_header_validation

    boolean


    default: false


    如果为 true,则跳过请求头验证。

  • skip_query_params_validation

    string


    default: false


    跳过查询参数验证。

  • skip_path_params_validation

    string


    default: false


    跳过路径参数验证。

  • reject_if_not_match

    boolean


    default: true


    如果为 false,OAS 验证失败的请求仅记录错误日志,但仍会转发到上游服务。

    自 API7 Enterprise 3.9.6 版本起可用,APISIX 中不可用。

  • rejection_status_code

    integer


    default: 400


    vaild vaule:

    400–599


    请求验证失败时返回的 HTTP 状态码。例如,设置为 422 以区分语义验证错误(Unprocessable Entity)和格式错误的请求语法(400 Bad Request)。仅在 reject_if_not_matchtrue 时生效。

    自 API7 Enterprise 3.9.8 版本起可用。APISIX 中尚不可用。