在AWS API Gateway创建请求校验模型时遇if/then关键字不支持问题

结论 #

AWS API Gateway的请求校验模型仅支持JSON Schema Draft 4，而if/then是Draft 7新增的关键字，无法直接在AWS模型中使用，必须用Draft 4支持的关键字实现等价逻辑。

替代方案 #

核心思路是通过oneOf、allOf、not这些Draft 4支持的关键字，拆分条件场景或排除非法组合。

场景1：互斥类型的条件约束

比如：当type为user时必填userId；为admin时必填adminRole。

原Draft 7 Schema（无法使用）：

{
  "type": "object",
  "properties": {
    "type": { "enum": ["user", "admin"] },
    "userId": { "type": "string" },
    "adminRole": { "type": "string" }
  },
  "if": { "properties": { "type": { "const": "user" } } },
  "then": { "required": ["userId"] },
  "else": { "required": ["adminRole"] }
}

Draft 4 等价实现：
用oneOf拆分两个互斥的合法场景：

{
  "type": "object",
  "oneOf": [
    {
      "properties": {
        "type": { "enum": ["user"] },
        "userId": { "type": "string" }
      },
      "required": ["type", "userId"]
    },
    {
      "properties": {
        "type": { "enum": ["admin"] },
        "adminRole": { "type": "string" }
      },
      "required": ["type", "adminRole"]
    }
  ]
}

场景2：存在字段时的依赖约束

比如：如果存在email字段，则必须同时存在emailVerified字段。

原Draft 7 Schema（无法使用）：

{
  "type": "object",
  "properties": {
    "email": { "type": "string" },
    "emailVerified": { "type": "boolean" }
  },
  "if": { "required": ["email"] },
  "then": { "required": ["emailVerified"] }
}

Draft 4 等价实现：
用allOf结合not排除“有email但无emailVerified”的非法情况：

{
  "type": "object",
  "properties": {
    "email": { "type": "string" },
    "emailVerified": { "type": "boolean" }
  },
  "allOf": [
    {
      "not": {
        "required": ["email"],
        "not": { "required": ["emailVerified"] }
      }
    }
  ]
}

或者用oneOf拆分两种合法情况（有email则必带emailVerified，或完全不带email）：

{
  "type": "object",
  "oneOf": [
    {
      "required": ["email", "emailVerified"],
      "properties": {
        "email": { "type": "string" },
        "emailVerified": { "type": "boolean" }
      }
    },
    {
      "not": { "required": ["email"] }
    }
  ]
}

注意事项 #

• 确保所有关键字均为JSON Schema Draft 4支持的：type、properties、required、enum、oneOf、allOf、not、items、additionalProperties等。
• 复杂场景下优先用oneOf拆分清晰的合法分支，可读性更强。

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