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.2 格式
创建时间: 2025-05-29 16:38
符合 OpenAPI 规范的 OpenAPI 文档本身是一个 JSON 对象,可以以JSON 或YAML 格式表示。
例如,如果某个字段具有数组值,则将使用 JSON 数组表示形式
{
"field": [ 1, 2, 3 ]
}
规范中的所有字段名称都区分大小写。这包括用作映射中键的所有字段,除非明确指出键不区分大小写。
架构公开两种类型的字段:固定字段,具有声明的名称;模式字段,为字段名称声明正则表达式模式。
模式字段必须在包含的对象中具有唯一的名称。
为了保留在 YAML 和 JSON 格式之间进行双向转换的能力,YAML 1.2 版本建议与一些其他约束一起使用
- 标签必须限于 JSON Schema 规则集 允许的标签。
- YAML 映射中使用的键必须限于标量字符串,如 YAML Failsafe 架构规则集 定义的那样。
注意: 虽然 API 可以通过 YAML 或 JSON 格式的 OpenAPI 文档来定义,但 API 请求和响应主体以及其他内容不需要是 JSON 或 YAML。
最后更新: -