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.4 数据类型
创建时间: 2025-05-29 16:38
OAS 中的数据类型基于 JSON 架构规范草案 2020-12 支持的类型。请注意,integer
作为一种类型也受支持,并且被定义为没有小数部分或指数部分的 JSON 数字。模型使用 架构对象 定义,它是 JSON 架构规范草案 2020-12 的超集。
如 JSON 架构验证词汇表 所定义,数据类型可以具有可选的修饰符属性:format
。OAS 定义了其他格式,以便为基本数据类型提供更详细的信息。
OAS 定义的格式为
类型 | 格式 | 注释 |
---|---|---|
整数 | int32 | 带符号的 32 位 |
整数 | int64 | 带符号的 64 位(又名长整型) |
数字 | float | |
数字 | double | |
字符串 | 密码 | 提示 UI 隐藏输入。 |
最后更新: -