json-schema附加元数据

时间:2017-02-21 01:38:49

标签: javascript json metadata jsonschema

可以向json架构属性添加其他元素或自定义元数据(标题和描述除外)吗?

理想情况下,我想添加一些元数据:

//...
"properties": {
  "contactFullName": {
    "$ref": "#/definitions/fullName",
    "custom": "my custom metadata here"
  }
}
//...

您可以向definitions添加内容以允许该内容吗?

2 个答案:

答案 0 :(得分:7)

您无需执行任何特殊操作即可使用其他元数据关键字。你可以使用它们。在JSON Schema中,包含未定义的关键字不是错误。任何没有JSON Schema语义的东西都应该被忽略。因此,以下模式完全有效,不应与任何验证器实现冲突。

{
  "title": "Foo",
  "description": "All the foo you can GET",
  "version": "1.0.3",
  "author": "Jason Desrosiers",
  "type": "object",
  "properties": {
    "id": { "type": "string" }
  }
}

答案 1 :(得分:2)

您可以使用description属性并在其中放置某个结构,然后可以根据需要进行解释和应用(比如JSON模式中的JSON,可以这么说)。