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.8.1 OpenAPI 对象
4.8.2 Info 对象
4.8.3 Contact 对象
4.8.4 License 对象
4.8.5 Server 对象
4.8.6 Server Variable 对象
4.8.7 Components 对象
4.8.8 Paths 对象
4.8.9 Path Item 对象
4.8.10 Operation 对象
4.8.11 External Documentation 对象
4.8.12 Parameter 对象
4.8.13 Request Body 对象
4.8.14 Media Type 对象
4.8.15 Encoding 对象
4.8.16 Responses 对象
4.8.17 Response 对象
4.8.18 Callback 对象
4.8.19 Example 对象
4.8.20 Link 对象
4.8.21 Header 对象
4.8.22 Tag 对象
4.8.23 Reference 对象
4.8.24 Schema 对象
4.8.25 Discriminator 对象
4.8.26 XML 对象
4.8.27 Security Scheme 对象
4.8.28 OAuth Flows 对象
4.8.29 OAuth Flow 对象
4.8.30 Security Requirement 对象
4.9 规范扩展
4.10 安全过滤
4.6 URI 中的相对引用
创建时间: 2025-05-29 16:38
除非另有说明,否则所有作为 URI 的属性可以是 [RFC3986] 第 4.2 节 中定义的相对引用。
相对引用,包括 引用对象
、路径项对象
$ref
字段、链接对象
operationRef
字段和 示例对象
externalValue
字段中的相对引用,都使用引用文档作为根据 [RFC3986] 第 5.2 节 的基本 URI 进行解析。
如果 URI 包含片段标识符,则应根据引用文档的片段解析机制解析片段。如果引用文档的表示形式为 JSON 或 YAML,则片段标识符应该被解释为根据 [RFC6901] 的 JSON 指针。
架构对象
中的相对引用,包括任何作为 $id
值出现的相对引用,都使用最近的父级 $id
作为基本 URI,如 JSON 架构规范草案 2020-12 中所述。如果没有任何父架构包含 $id
,则必须根据 [RFC3986] 第 5.1 节 确定基本 URI。
最后更新: -