JSON Type Definitions and References

Q

How to define a JSON type and reference it in JSON Schema?

✍: FYIcenter.com

A

If you want to define a JSON type, and reference it later in your JSON Schema, you can:

1. Name your JSON type can put it inside the "definitions" property. For example, "rating" as a JSON type can be defined as shown below:

{
    "definitions": {
        "rating": {
            "type": "integer",
            "minimum": 0,
            "maximum": 5
        }
    },
	...
}

2. Use "$ref" instead of "type" property to refer to a previously defined JSON type. For example, the following JSON schema defines a JSON Object that should have two properties with the same JSON type "rating":

{
    ...
    "type": "object",
    "properties": {
        "clarity": {
            "$ref": "#/definitions/rating"
        },
        "efficiency": {
            "$ref": "#/definitions/rating"
        }
    }
}

 

Introduction of JSON Schema

⇒⇒JSON Tutorials

2017-08-25, 178👍, 0💬