OpenAPI 规范 v3.1.0
OpenAPI 规范 v3.1.0
1. OpenAPI 规范
2. 简介
3. 定义
4. 规范
4.1 版本
4.2 格式
4.3 文档结构
4.4 数据类型
4.5 富文本格式化
4.6 URI 中的相对引用
4.7 URL 中的相对引用
4.8 模式
4.9 规范扩展
4.10 安全过滤
4.8.23 Reference 对象
创建时间: 2025-05-29 16:38

一个简单的对象,用于在 OpenAPI 文档中(内部和外部)引用其他组件。$ref 字符串值包含一个 URI [RFC3986],它标识被引用值的位置。请参阅有关解析相对引用的规则。

4.8.23.1 固定字段
字段名称类型描述
$ref字符串必需。引用标识符。此标识符必须采用 URI 的形式。
summary字符串简短摘要,默认情况下应该覆盖被引用组件的摘要。如果被引用的对象类型不允许使用 summary 字段,则此字段无效。
description字符串描述,默认情况下应该覆盖被引用组件的描述。[CommonMark] 语法可以用于富文本表示。如果被引用的对象类型不允许使用 description 字段,则此字段无效。
4.8.23.2 Reference 对象示例
{
	"$ref": "#/components/schemas/Pet"
}
$ref: '#/components/schemas/Pet'
4.8.23.3 相对 Schema 文档示例
{
  "$ref": "Pet.json"
}
$ref: Pet.yaml
4.8.23.4 包含嵌入式 Schema 的相对文档示例
{
  "$ref": "definitions.json#/Pet"
}
$ref: definitions.yaml#/Pet
最后更新: -