Referenceオブジェクト

OpenAPI ドキュメント内の他のコンポーネントを内部および外部から参照できるようにする単純なオブジェクトです。

$ref文字列値には、参照される値の場所を識別するURI RFC3986が含まれています。

相対参照を解決するためのルールを参照してください。

固定フィールド

フィールド名	タイプ	説明
$ref	`string`	必須。参照識別子。これは URI の形式でなければなりません。
まとめ	`string`	デフォルトで、参照されるコンポーネントの概要をオーバーライドする必要がある短い概要。参照されるオブジェクトタイプで`summary`フィールドが許可されない場合、このフィールドは効果がありません。
説明	`string`	デフォルトで参照されるコンポーネントの説明をオーバーライドする必要がある説明。CommonMark 構文はリッチテキスト表現に使用できます (MAY)。参照されるオブジェクトタイプで`description`フィールドが許可されない場合、このフィールドは効果がありません。

このオブジェクトは追加のプロパティで拡張することはできず、追加されたプロパティはすべて無視されます。

Schema Objects追加プロパティに対するこの制限は、$refキーワードを含む参照オブジェクトとの違いであることに注意してください。

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

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

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

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