数组中某些对象属性的JSON模式条件检查

时间:2019-09-27 13:38:04

标签: json jsonschema json-schema-validator ajv

我想通过AJV进行的操作-JSON模式验证或自定义关键字(最好是与此相关):数组可以具有1个或2个JSON对象,类型分别为“ admin”和“ guest”。 “ type”:“ guest”对象将始终存在,而“ type”:“ admin”对象是可选的。

附加说明:

-该对象本身将来可能包含附加属性和嵌套对象

-其他有效的枚举是superadmin,admin,user和guest

-数组中的类型顺序为:superadmin,admin,user和guest。是否可以检查顺序? (尽管是可选的)

-“访客”类型的对象将始终存在,并且将存在唯一类型的对象。如果重新出现任何对象类型(例如,超级管理员,管理员,用户和来宾),则错误

//这是模式:

{
"type": "object",
"properties": {
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "type": { "enum": ["guest", "admin"]
    },
    "rights": {"type": "string"},
    "hyperLink": {"type": "string", "format": "uri"}
    }
  }
  }
}

我需要在json中的某处添加“ checkTypeAndValue”标志,以便我可以获取完整的JSON对象和相应的属性以进行编程检查?

const checkTypeAndValue = function (schema, completeJSONObj) {
 //
};

ajv.addKeyword('checkTypeAndValue', {
  validate: checkTypeAndValue,
  errors: true
});

这是一些有效和无效的示例:

/Valid 1: As type is 'admin' and so 'rights' SHOULD NOT be in 'guest' object
{
  [
    {
      "type":"admin",
      "hyperLink": "http://www.someguest.com",
      "rights":"all"
    },
    {
      "type":"guest",
      "hyperLink": "http://www.someadmin.com"
    }
  ]
}

//Valid 2: You can have a SINGLE 'guest' object. 'admin' object is not required all the time
{
  [
    {
      "type":"guest",
      "hyperLink": "http://www.someadmin.com",
      "rights": "limited" //MANDATORY or REQUIRED Attribute
    }
  ]
}

//InValid
{
  [
    {
      "type":"admin",
      "hyperLink": "http://www.someguest.com",
      "rights":"all"
    },
    {
      "type":"guest",
      "hyperLink": "http://www.someadmin.com",
      "rights":"limited"
      //Error ==> As rights=all is there in 1st object, you cannot set 'rights' to any value including blank even having 'rights' attribute is not valid.
    }
  ]
}

这是我需要解决的if if else条件:

//Assuming admin object exist with rights....
if( type == admin && rights != ""){
  if(type == guest && rights attribute is there && rights != ""){
    //The 'guest' object will always be there....
    //error: guest 'rights' cannot have a value if type is 'admin' and rights is 'all' or any other value.
  }
}else{
   //Assuming mandatory guest object exist with rights....
   if(guest.rights does not exist OR guest.rights == "")
    //Error: 'rights' is MANDATORY attribute in guest block and error if its empty
   else 
    //Everything is fine
}

还有什么方法可以检查数组中只有一对特定类型的对象? 例如:只有一种“访客”,“管理员”类型。错误,如果“访客”或“管理员”的类型不止一种

//完整示例

{
  [
    {
      "type":"superadmin",
      "hyperLink": "http://www.superadmin.com"      
    },
    {
      "type":"admin",
      "hyperLink": "http://www.admin.com",
      "rights":"all"
    },
    {
      "type":"user",
      "hyperLink": "http://www.user.com"
    },
    {
      "type":"guest",
      "hyperLink": "http://www.guest.com"
    }
  ]
}

1 个答案:

答案 0 :(得分:1)

使用JSON模式执行此操作似乎有些棘手,但有可能。

您需要能够有条件地检查否定条件。

因此,您需要将ifthennot结合使用。

首先,条件是:如果有管理员用户。然后,使用if,我们可以有条件地应用其他检查规则。

接下来,检查:来宾用户不能拥有rights

then通过验证时,将应用

if。然后,我们需要使用guest来取消对rights是否具有not的检查。

对于使用https://jsonschema.dev提供的示例预期无效JSON数据,您会看到此验证验证失败(链接已预先加载了此架构和您提供的实例数据。它在浏览器btw中使用AJV。)


更新:我已经更新了架构以满足您的其他要求。 我还更新了上面的演示链接。

现在,该架构仅允许在具有admin的情况下让admin拥有权限,而在具有admin的情况下,其他任何用户类型都不能具有权限。另外,数组中的一项必须具有权限(根据需要)。

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "array",
  "if": {
    "contains": {
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "const": "admin"
        }
      }
    }
  },
  "then": {
    "not": {
      "contains": {
        "required": [
          "type",
          "rights"
        ],
        "properties": {
          "type": {
            "not": {
              "const": "admin"
            }
          }
        }
      }
    }
  },
  "contains": {
    "type": "object",
    "required": ["rights"]
  },
  "items": {
    "type": "object",
    "properties": {
      "type": {
        "enum": [
          "guest",
          "admin"
        ]
      },
      "rights": {
        "type": "string"
      },
      "hyperLink": {
        "type": "string",
        "format": "uri"
      }
    }
  }
}