class OpenApiDocument

public class OpenApiDocument <: IOpenApiSerializable

功能：表示 OpenAPI 文档对象。

父类型：

• IOpenApiSerializable

成员概览

成员	功能
init()	创建 OpenAPI 文档对象。
var openapi	表示 OpenAPI 版本号。
var info	表示文档基本信息。
var paths	表示路径集合。
var components	表示组件集合。
var tags	表示标签集合。
var servers	表示服务器集合。
var securityRequirements	表示安全需求集合。
func serializeAsV3(IOpenApiWriter)	按 OpenAPI V3 格式写出当前文档对象。

init()

public init()

功能：创建 OpenAPI 文档对象。

var openapi

public var openapi: String = "3.0.1"

功能：表示 OpenAPI 版本号。

类型：String

var info

public var info: ?OpenApiInfo = None

功能：表示文档基本信息。

类型：?OpenApiInfo

var paths

public var paths: ?OpenApiPaths = None

功能：表示路径集合。

类型：?OpenApiPaths

var components

public var components: ?OpenApiComponents = None

功能：表示组件集合。

类型：?OpenApiComponents

var tags

public var tags = ArrayList<OpenApiTag>()

功能：表示标签集合。

var servers

public var servers = ArrayList<OpenApiServer>()

功能：表示服务器集合。

var securityRequirements

public var securityRequirements = ArrayList<OpenApiSecurityRequirement>()

功能：表示安全需求集合。

func serializeAsV3(IOpenApiWriter)

public func serializeAsV3(writer: IOpenApiWriter): Unit

功能：按 OpenAPI V3 格式写出当前文档对象。

参数：

• writer: IOpenApiWriter - OpenAPI 写入器。

返回值：

• Unit