Skip to content

class OpenApiInfo

cangjie
public class OpenApiInfo <: IOpenApiSerializable

功能:表示 OpenAPI 基本信息。

父类型:

成员概览

成员功能
init(String, String)创建 OpenAPI 基本信息实例。
var title表示文档标题。
var description表示文档描述。
var version表示文档版本。
var contact表示联系人信息。
var license表示许可证信息。
func serializeAsV3(IOpenApiWriter)按 OpenAPI V3 格式写出当前基本信息。

init(String, String)

cangjie
public init(title!: String, version!: String)

功能:创建 OpenAPI 基本信息实例。

参数:

  • title: String - 文档标题。
  • version: String - 文档版本。

var title

cangjie
public var title: ?String = None

功能:表示文档标题。

类型:?String

var description

cangjie
public var description: ?String = None

功能:表示文档描述。

类型:?String

var version

cangjie
public var version: ?String = None

功能:表示文档版本。

类型:?String

var contact

cangjie
public var contact: ?OpenApiContact = None

功能:表示联系人信息。

类型:?OpenApiContact

var license

cangjie
public var license: ?OpenApiLicense = None

功能:表示许可证信息。

类型:?OpenApiLicense

func serializeAsV3(IOpenApiWriter)

cangjie
public func serializeAsV3(writer: IOpenApiWriter): Unit

功能:按 OpenAPI V3 格式写出当前基本信息。

参数:

返回值:

  • Unit