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.9 规范扩展
创建时间: 2025-05-29 16:38
虽然OpenAPI规范试图适应大多数用例，但可以在某些点添加其他数据来扩展规范。扩展属性实现为模式化字段，这些字段始终以"x-"为前缀。
| 字段模式 | 类型 | 描述 |
|---|---|---|
| ^x- | 任何 | 允许扩展OpenAPI模式。字段名称必须以x-开头，例如x-internal-id。以x-oai-和x-oas-开头的字段名称保留用于OpenAPI Initiative定义的用途。该值可以为null、基本类型、数组或对象。 |
可用的工具可能支持也可能不支持扩展，但这些工具也可以扩展以添加请求的支持（如果工具是内部的或开源的）。
最后更新: -