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.1 版本
创建时间: 2025-05-29 16:38
OpenAPI 规范使用 major
.minor
.patch
版本控制方案。版本字符串的 major
.minor
部分(例如 3.1
)必须指定 OAS 功能集。 .patch
版本解决此文档中的错误或提供澄清,而不是功能集。支持 OAS 3.1 的工具应该与所有 OAS 3.1.* 版本兼容。补丁版本不应该被工具考虑,例如不区分 3.1.0
和 3.1.1
。
偶尔,在 OAS 的 minor
版本中可能会进行不向后兼容的更改,如果认为更改对提供的好处的影响较小。
与 OAS 3.. 兼容的 OpenAPI 文档包含一个必需的 openapi
字段,该字段指定它使用的 OAS 版本。
最后更新: -