Request Validation 配置选项
request-validation 插件在请求转发到上游服务之前检查其是否符合要求,从而提高 API 操作的安全性。 配置涵盖静态设置和插件参数。
静态配置
apisix.max_request_headers_readable 配置项控制 request-validation 评估 header_schema 时可用的请求头数量。该配置项从 APISIX 3.20.0 和 API7 企业版 3.10.10 开始可用;较早版本固定为 100 个请求头。
配置位置取决于网关的部署方式:
- 主机或 Docker
- API7 网关 Helm
在持久化网关配置中设置上限:
apisix:
max_request_headers_readable: 200 # 默认值:100;0 表示读取所有请求头。
更新 config.yaml 后,重新加载或 重启每个网关实例。
使用 API7 网关 Helm Chart 3.10.19 或更高版本时,设置对应的 Chart 配置项:
apisix:
maxRequestHeadersReadable: 200 # 默认值:100;0 表示读取所有请求头。
按照该网关 Helm release 的常规升级流程应用配置文件。
该配置项仅改变插件可见的请求头表,不改变 NGINX 的解析限制;超出插件可见上限的请求头仍可能到达上游。
参数
有关所有插件均可使用的配置项,请参阅插件通用配置。
header_schema
请求头的 Schema。
必须至少配置
header_schema和body_schema中的一个。body_schema
请求体的 Schema。
必须至少配置
header_schema和body_schema中的一个。rejected_code
有效值:
介于 200 和 599 之间(含边界值)拒绝请求时返回的状态码。
rejected_msg
拒绝请求时返回的消息。
max_req_body_size
有效值:
大于或等于 1配置
body_schema时读取的请求体最大字节数。超过该大小的请求体会使用rejected_code拒绝,后者默认为400。仅配置header_schema时,此字段无效。自 API7 企业版 3.9.17 和 3.10.4 以及 APISIX 3.18.0 起引入。