Reference 对象

一个允许引用  规范内部的其他部分或外部规范的对象。

Reference 对象 定义于 JSON Reference 且遵循相同的结构、行为和规则。

For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification.

固定字段

字段名	类型	描述
$ref	string	必选. 引用字符串。

此对象不能被扩展，任何附加的属性将会被忽略。

Reference 对象示例

{
  "$ref": "#/components/schemas/Pet"
}

$ref: '#/components/schemas/Pet'

关联外部文档示例

{
  "$ref": "Pet.json"
}

$ref: Pet.yaml

关联外部文档的一部分

{
  "$ref": "definitions.json#/Pet"
}

$ref: definitions.yaml#/Pet