支持std :: map< std :: string,T>在json架构中

时间:2013-07-30 12:38:36

标签: json jsonschema

是否有标准方法将属性指定为字符串或由字符串键控的映射,并在模式中的其他位置指定值类型T?

例如,假设您要为用户喜欢的电影建模,其中键类型是电影的名称,值类型是关于电影的一些属性集(年份,预算,总收入等)< / p>

我想你可以首先将MovieDataPair建模为具有 name 属性的类型和包含所需属性的 value 属性。然后地图就是那些数组。但是,那么你需要一个特殊的唯一约束来确保任何电影名称只出现一次。

json架构中是否有支持此功能的东西,或者用于它的标准模式? 如果没有在json架构中内置支持,那么其他架构解决方案呢?

3 个答案:

答案 0 :(得分:5)

经过一番研究后,我得出了以下答案:

查看此操作的最佳方法是查找一些示例。它 碰巧在draft04模式中有几个这样的例子 本身(定义属性 patternProperties ,...)和他们 通常遵循相同的模式。

例如,draft04模式的 definitions 属性定义了什么 应出现在 definitions 属性的架构中。这里是 与 definitions 属性关联的子模式:

"definitions": {
    "type": "object",
    "additionalProperties": { "$ref": "#" },
    "default": {}
},

这表示“#/ definitions /”的条目必须是一个对象。事实 它是一个json对象意味着它将拥有唯一的键。现在 对于对象中的,这就是 additionalProperties 的含义 旨在描述。在这种情况下,它表示每个的价值 属性必须符合模式“#”的根。这是什么 表示有效json模式的 definitions 属性对象中的每个值 对象也必须是架构。 如果输入类似于C ++,它可能看起来像:

std::map< std::string, Schema > definitions;

有效地,带有字符串键的地图可以被视为像json一样 具有结构化值类型的对象。所以,要创建自己的:

std::map< std::string, T >
  • 首先定义T的架构。例如:

    "definitions" : {
       "movie" : {
           "properties": {
              "title" : { "type" : "string" },
              "year_made" : { "type" : "integer" },
              "rating" : { "type" : "integer" }
           }
        }
    }
    
  • 对于存储的值类型T,决定是否要允许任何值 属性,只要这些指定的属性被键入为 如上所述。如果您只想要这些属性,请添加 “additionalProperties”:false

     "definitions" : {
       "movie" : {
           "additionalProperties" : false,
           "properties": {
              "title" : { "type" : "string" },
              "year_made" : { "type" : "integer" },
              "rating" : { "type" : "integer" }
           }
        }
     }
    
  • 还要确定您是否确实需要所有属性 目前电影有效。如果是,请添加必需的条目。

    "definitions" : {
      "movie" : {
        "additionalProperties": false,
        "required" : [ "title", "year_made", "rating" ],
        "properties": {
          "title" : { "type" : "string" },
          "year_made" : { "type" : "integer" },
          "rating" : { "type" : "integer" }
      }
    },
    
  • 现在定义了电影的形状 T.为...创建定义 引用电影架构的电影集合或地图 定义为草图模式中的 definitions 。注意:在 “movie_map” additionalProperties 具有不同的含义 那部电影。在“movie”的情况下,它是一个布尔 false 这表示除了列出的内容之外没有其他属性 属性。在“movie_map”的情况下,它意味着 - 如果有的话 其他属性,它们必须看起来像这个架构。但, 因为 movie_map 中没有指定属性,所以它的确意味着 对象实例中的所有属性必须符合#/ definitions / movie。现在全部 “movie_map”中的值将类似于已定义的 movie 架构。​​

    {
      "definitions" : {
        "movie" : {
          "additionalProperties": false,
          "required" : [ "title", "year_made", "rating" ],
          "properties": {
            "title" : { "type" : "string" },
            "year_made" : { "type" : "integer" },
            "rating" : { "type" : "integer" }
          }
        },
        "movie_map" : {
          "type": "object",
          "additionalProperties": { "$ref": "#/definitions/movie" },
          "default": {}
        }
      }
    }
    
  • 现在在架构中的某处使用已定义的架构 movie_map

    {
      "title" : "movie data",
      "additionalProperties" : false,
      "required" : [ "movies" ],
      "properties" : {
        "movies" : { "$ref" : "#/definitions/movie_map" }
      },
      "definitions" : {
        "movie" : {
          "additionalProperties": false,
          "required" : [ "title", "year_made", "rating" ],
          "properties": {
            "title" : { "type" : "string" },
            "year_made" : { "type" : "integer" },
            "rating" : { "type" : "integer" }
          }
        },
        "movie_map" : {
          "type": "object",
          "additionalProperties": { "$ref": "#/definitions/movie" },
          "default": {}
        }
      }
    }
    

这是一个示例对象,可以被认为是电影的地图 验证模式:

{
  "movies" : {
    "the mission" : {
      "title":"The Mission",
      "year_made":1986,
      "rating":5
    },
    "troll 2" : {
      "title":"Troll 2",
      "year_made":1990,
      "rating":2
    }
  }
}

enter image description here

答案 1 :(得分:1)

如果我想为用户收藏电影建模一个结构(提醒Json Schema用于结构验证),我会做类似的事情:

{
"description":"moviesFan",
"properties": [
    "favoriteMovies": {
        "type":"array",
        "uniqueItems":True
        "allOf": [{ "$ref": "#/definitions/movie" }]
    }
],
"definitions": {
    "movie": {
        "type": "object",
        "properties": {
            "yearMade": {}
            ...
        }
    }
}

对你有意义吗?

答案 2 :(得分:0)

这是我支持地图的方式。希望能提供帮助。


    {
      "type": "object",
      "title": "map data",
      "required": [
        "map"
      ],
      "properties": {
        "sOnePurRecord": {
          "title": "map",
          "additionalProperties": false,
          "properties": {
            "mapItem": {
              "type": "object",
              "maxProperties": 10,
              "minProperties": 1,
              "patternProperties": {
                "^[a-zA-Z0-9]{5,20}$": {
                  "$ref": "#/definitions/value"
                }
              },
              "additionalProperties": {
                "$ref": "#/definitions/value"
              }
            }
          },
          "required": [
            "mapItem"
          ]
        }
      },
      "definitions": {
        "value": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "id": {
              "type": "integer"
            }
          }
        }
      }
    }