跳到主要内容

参数

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

  • spec

    string


    包含 OpenAPI 规范的字符串。与 spec_url 互斥。

    内联规范受控制面 2 MB 大小限制。如果你的 OpenAPI 规范超过此限制,请改用 spec_url 从远程 URL 加载。

  • spec_url

    string


    用于获取 OpenAPI 规范的 URL(必须以 http://https:// 开头)。与 spec 互斥。获取的规范使用可配置的 TTL 缓存(参见插件元数据 spec_url_ttl),过期条目在后台异步刷新期间继续提供服务。

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

  • spec_url_request_headers

    object


    获取 spec_url 时包含的自定义 HTTP 头(例如用于认证)。

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

  • ssl_verify

    boolean


    default: false


    获取 spec_url 时是否验证 SSL 证书。

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

  • timeout

    integer


    default: 10000


    vaild vaule:

    1000–60000


    获取 spec_url 时的 HTTP 请求超时(毫秒)。

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

  • 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 中尚不可用。

备注

必须配置 specspec_url 其中之一,两者互斥。

插件元数据

  • spec_url_ttl

    integer


    default: 3600


    spec_url 获取的规范缓存的 TTL(秒)。过期后,过期条目在后台异步刷新时继续提供服务。

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