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 安全过滤
OpenAPI 规范 v3.1.0
创建时间: 2025-05-29 16:38
OpenAPI 规范 v3.1.0
版本 3.1.0
2021 年 2 月 15 日
关于此文档的更多详细信息
-
此版本
-
最新发布版本
-
最新编辑草案
-
编辑
- Darrel Miller
- Jeremy Whitlock
- Marsh Gardiner
- Mike Ralphson
- Ron Ratovsky
- Uri Sarid
-
前任编辑
- Jason Harmon
- Tony Tam
-
参与
版权所有 © 2021 Linux 基金会
什么是 OpenAPI 规范?
OpenAPI 规范 (OAS) 定义了一种标准的、与编程语言无关的 HTTP API 接口描述,使人和计算机都能够发现和理解服务的的能力,而无需访问源代码、其他文档或检查网络流量。当通过 OpenAPI 正确定义时,使用者只需最少的实现逻辑即可理解并与远程服务进行交互。类似于接口描述对较低级别编程的作用,OpenAPI 规范消除了调用服务的猜测。
本文档的状态
此规范的真实来源是上面引用的 HTML 文件,即“此版本”。
最后更新: -