OpenAPI 对象

这是OpenAPI document的根文档对象。

固定字段

字段名	类型	描述
openapi	string	必选. 这个字符串必须是开放 API 规范版本号提到的符合语义化版本号规范的版本号。openapi字段应该被工具或者客户端用来解释 OpenAPI 文档。这个值和 API info.version字符串没有关联。
info	Info 对象	必选。此字段提供 API 相关的元数据。相关工具可能需要这个字段。
servers	[Server 对象]	这是一个 Server 对象的数组， 提供到服务器的连接信息。如果没有提供servers属性或者是一个空数组，那么默认为是url值为/的 Server 对象 。
paths	Paths 对象	必选。对所提供的 API 有效的路径和操作。
components	Components 对象	一个包含多种结构的元素。
security	[Security Requirement 对象]	声明 API 使用的安全机制。The list of values includes alternative security requirement objects that can be used. 认证一个请求时仅允许使用一种安全机制。单独的操作可以覆盖这里的定义。
tags	[Tag 对象]	提供更多元数据的一系列标签，标签的顺序可以被转换工具用来决定 API 的顺序。不是所有被Operation 对象用到的标签都必须被声明。没有被声明的标签可能被工具按自己的逻辑任意整理，每个标签名都应该是唯一的。
externalDocs	External Documentation 对象	附加的文档。这个对象可能会被规范扩展扩展。