OpenAPI 对象
这是OpenAPI document的根文档对象。
Info 对象
这个对象提供 API 的元数据。如果客户端需要时可能会用到这些元数据,而且可能会被呈现在编辑工具或者文档生成工具中。
Contact 对象
所公开的 API 的联系人信息。
License 对象
公开 API 的证书信息。
Server 对象
表示一个服务器的对象。
Components 对象
包含开放 API 规范固定的各种可重用组件。当没有被其他对象引用时,在这里定义定义的组件不会产生任何效果。
Paths 对象
定义各个的端点和操作的相对路径。这里指定的路径会和 Server 对象 内指定的 URL 地址组成完整的 URL
Path Item 对象
描述对一个路径可执行的有效操作。依赖与 ACL constraints 的设置,一个 Path Item
Operation 对象
描述对路径的某个操作。
External Documentation 对象
允许引用外部资源来扩展文档。
Request Body 对象
定义请求体。
Media Type 对象
每种媒体类型对象都有相应的结构和示例来描述它。
Response 对象
描述单个 API 操作的响应,包括设计时间、基于不同响应也包括到相应操作的静态 links。
Callback 对象
A map of possible out-of band callbacks related to the parent operation.
Example 对象
固定字段
Link 对象
The Link 对象 represents a possible design-time link for a response.
Header 对象
Header 对象除了以下改动之外与 Parameter 对象 一致:
Tag 对象
Adds metadata to a single tag that is used by the Operation 对象.
Reference 对象
一个允许引用 规范内部的其他部分或外部规范的对象。
Schema 对象
用于定义输入和输出的数据类型。这些类型可以是对象,但也可以是原始值和数组。这个对象是 JSON Schema Specification Wright Draft 00
Discriminator 对象
当一个 request bodies 或 response payloads 可以是多种 schemas 时,可以使用一个 discriminator 对象来帮助序列化、反序列化和校验。
XML 对象
一个为 XML 模型定义微调过的元数据对象。
Security Scheme 对象
定义一个用于 operations 的 security scheme。被支持的 schemes 有 HTTP 认证,一个 API key(作为 header 或 query
OAuth Flows 对象
允许配置支持的 OAuth Flows。
Security Requirement 对象
列出执行此 operation 所需的 security schemes。每个属性的名字都必须 与