WSO2 APIM 3.1无法通过Schema校验器验证Header参数，求实现方法

我之前在WSO2 APIM 3.1里也碰到过一模一样的问题——JSON Body的Schema校验正常工作，但Header参数的校验完全没触发，哪怕配置了必填项也没报错。后来折腾了一阵才搞清楚，APIM默认并没有开启Header的Schema校验，得手动做几个配置调整，下面一步步给你说：

1. 确认OpenAPI/Swagger定义中Header参数的配置正确性 #

首先得确保你的API定义里，Header参数的Schema和必填规则是正确配置的。别只依赖APIM UI里勾选“必填”，必须保证OpenAPI定义里的required属性和schema结构完整，示例如下：

openapi: 3.0.1
info:
  title: Sample API
  version: 1.0.0
paths:
  /sample:
    get:
      parameters:
        - in: header
          name: X-Required-Header
          schema:
            type: string
            minLength: 5
          required: true
      responses:
        '200':
          description: OK

APIM的校验逻辑是基于这个定义生成的，所以这一步是基础。

2. 修改API的In Sequence，开启Header校验 #

APIM默认的Schema校验器（Validate Mediator）只会校验请求Body，要让它处理Header，需要手动修改API的入站序列：

• 登录APIM Publisher，找到你的目标API，进入Runtime Configurations -> Sequence
• 编辑In Sequence，找到<validate> mediator节点（如果没有的话，需要先添加这个 mediator）
• 在<validate>里添加<source type="header"/>，最终配置类似这样：

<validate xmlns="http://ws.apache.org/ns/synapse">
    <schema key="conf:/repository/resources/schemas/{你的API对应的Schema路径}"/>
    <source type="body"/>
    <source type="header"/>
    <on-fail>
        <makefault version="soap11">
            <code value="soap11:Client"/>
            <reason value="Invalid Request"/>
            <detail value="Request does not conform to the defined schema. Check your header parameters."/>
        </makefault>
        <respond/>
    </on-fail>
</validate>

• 保存序列后，重新发布API，让配置生效。

3. 开启Gateway的Header校验开关 #

除了序列配置，还需要确保APIM Gateway的全局配置允许Header校验：

• 打开Gateway节点的<APIM_HOME>/repository/conf/deployment.toml文件
• 添加或修改如下配置：

[apim.validation]
enable_header_validation = true

• 重启Gateway服务，让这个全局配置生效。

4. 测试验证 #

现在你可以测试一下：发送一个缺失必填Header或者Header不符合Schema规则（比如长度不够、类型错误）的请求，APIM应该会返回400 Bad Request，并带上你在<on-fail>里定义的错误信息，说明Header校验已经生效了。

额外注意点 #

• 如果你的API是通过Swagger文件导入的，导入后要检查APIM是否正确识别了Header参数的Schema，有时候导入过程可能会丢失部分属性，需要手动调整。
• 确保<validate> mediator在In Sequence里的位置正确，应该放在认证/授权步骤之后、后端服务调用之前，这样能在请求到达后端之前就拦截非法请求。

内容的提问来源于stack exchange，提问作者sudheer gundra