2017-02-21 75 views
3

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

理想我想添加一些元数据,像这样:

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

你能添加一些definitions允许吗?

回答

6

您不必为使用其他元数据关键字而特别做任何事情。你可以使用它们。在JSON模式中,包含未定义的关键字并不是一个错误。任何不具有JSON模式语义的应该被安静地忽略。所以,下面的模式是完全有效的,不应与任何验证器实现冲突。

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

你可以使用description属性,并在那里放置一个特定的结构,然后根据需要进行解释和应用(就像JSON模式内的JSON,可以这么说)。