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.8.1 OpenAPI 对象
创建时间: 2025-05-29 16:38
这是 OpenAPI 文档 的根对象。
4.8.1.1 固定字段
字段名称 | 类型 | 描述 |
---|---|---|
openapi | 字符串 | 必需 。此字符串必须是 OpenAPI 文档使用的 OpenAPI 规范的 版本号。openapi 字段应该被工具用来解释 OpenAPI 文档。这与 API info.version 字符串无关。** |
info | 信息对象 | 必需 。提供有关 API 的元数据。元数据可以根据需要由工具使用。 |
jsonSchemaDialect | 字符串 | 此 OAS 文档中包含的 架构对象 中 $schema 关键字的默认值。这必须采用 URI 的形式。 |
webhooks | Map[string , 路径项对象 | 引用对象] ] |
components | 组件对象 | 用于保存文档中各种架构的元素。 |
security | [安全需求对象] | 跨 API 可以使用哪些安全机制的声明。值的列表包括可以使用的替代安全需求对象。只需满足安全需求对象之一即可授权请求。各个操作可以覆盖此定义。若要使安全性可选,可以在数组中包含一个空的安全需求 ({} )。 |
tags | [标签对象] | 文档使用的一系列标签以及其他元数据。标签的顺序可以用于反映解析工具对其的顺序。并非 操作对象 使用的所有标签都必须声明。未声明的标签可以随机组织或基于工具的逻辑组织。列表中的每个标签名称必须唯一。** |
externalDocs | 外部文档对象 | 其他外部文档。 |
此对象可以使用 规范扩展 进行扩展。 |
最后更新: -