如何在APIM中检查空Header值并返回错误响应

你可以通过APIM的策略来实现这个需求，以下提供两种常用方案：

方案一：使用<validate-headers>策略（适合批量检查多个Header） #

该策略可以统一验证Header的存在性和值的格式，结合正则表达式判断空值：

<validate-headers specified-headers-only="true" errors-variable-name="headerValidationErrors">
  <!-- 替换为你需要检查的Header名称 -->
  <header name="X-Required-Header" exists="true">
    <value>^.+$</value> <!-- 正则匹配至少1个字符，确保值非空 -->
  </header>
  <!-- 可添加更多需要检查的Header -->
  <!-- <header name="Another-Required-Header" exists="true">
    <value>^.+$</value>
  </header> -->
</validate-headers>

<!-- 处理验证错误，返回400响应 -->
<choose>
  <when condition="@(context.Variables.GetValueOrDefault<IEnumerable<KeyValuePair<string, string>>>("headerValidationErrors")?.Any() == true)">
    <return-response>
      <set-status code="400" reason="Bad Request" />
      <set-body>@{
          var errors = context.Variables.GetValueOrDefault<IEnumerable<KeyValuePair<string, string>>>("headerValidationErrors");
          return $"请求错误：{string.Join("；", errors.Select(e => $"Header '{e.Key}' 缺失或为空"))}";
        }</set-body>
      <set-header name="Content-Type" exists-overwrite="true">
        <value>application/json; charset=utf-8</value>
      </set-header>
    </return-response>
  </when>
</choose>

代码说明 #

1. <validate-headers>的specified-headers-only="true"表示只检查我们定义的Header；
2. exists="true"确保Header必须存在；
3. <value>^.+$</value>通过正则表达式限制Header值不能是空字符串；
4. 验证错误会被存入headerValidationErrors变量，后续通过<choose>判断是否返回400错误。

方案二：直接使用<choose>策略（适合单个Header的简单检查） #

如果只需要检查单个Header，这种方式更简洁：

<choose>
  <!-- 替换为你需要检查的Header名称 -->
  <when condition="@(string.IsNullOrEmpty(context.Request.Headers.GetValueOrDefault("X-Required-Header", "")))">
    <return-response>
      <set-status code="400" reason="Bad Request" />
      <set-body>{"error": "Header 'X-Required-Header' 不能为空或缺失"}</set-body>
      <set-header name="Content-Type" exists-overwrite="true">
        <value>application/json; charset=utf-8</value>
      </set-header>
    </return-response>
  </when>
</choose>

代码说明 #

• context.Request.Headers.GetValueOrDefault("X-Required-Header", "")获取指定Header的值，若不存在则返回空字符串；
• string.IsNullOrEmpty()判断值是否为空或Header不存在，满足条件直接返回400错误响应。

使用方法 #

将上述任意一段策略代码添加到APIM的入站策略中（可以是API级、操作级或产品级，根据需求选择范围）。

内容的提问来源于stack exchange，提问作者kushma gonna