json-schema附加元数据

Question

It is possible to add additional or custom metadata (other than title and description) to a json schema property?

Ideally I'd like to add some metadata like so:

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

Can you add something to definitions to allow that?

Answer 1

You don't have to do anything special to use additional metadata keywords. You can just use them. In JSON Schema it is not an error to include undefined keywords. Anything that doesn't have JSON Schema semantics should be quietly ignored. So, the following schema is completely valid and should not conflict with any validator implementation.

{
  "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，可以这么说）。