json-schema附加元数据

Question

是否可以向json模式属性添加额外或自定义的元数据(标题和描述除外)？

理想情况下，我想添加一些元数据，如下所示：

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

你能在definitions中添加一些东西来实现这一点吗？

Answer 1

不需要做任何特殊的事情就可以使用其他元数据关键字。你可以直接使用它们。在JSON模式中，包含未定义的关键字并不是错误的。任何没有JSON Schema语义的东西都应该悄悄地忽略。因此，下面的模式是完全有效的，不应该与任何验证器实现冲突。

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

Answer 2

您可以使用description属性并在其中放置特定的结构，然后可以根据需要对其进行解释和应用(就像JSON模式中的JSON一样)。