Skip to content

class OpenApiTag

cangjie
public class OpenApiTag <: IOpenApiSerializable

功能:表示 OpenAPI 标签对象。

父类型:

成员概览

成员功能
init(?String, ?OpenApiReference, ?String)创建 OpenAPI 标签对象。
var name表示标签名称。
var description表示标签描述。
var reference表示标签引用。
func serializeAsV3(IOpenApiWriter)按 OpenAPI V3 格式写出当前标签对象。

init(?String, ?OpenApiReference, ?String)

cangjie
public init(name!: ?String = None, reference!: ?OpenApiReference = None, description!: ?String = None)

功能:创建 OpenAPI 标签对象。

参数:

  • name: ?String - 标签名称。
  • reference: ?OpenApiReference - 标签引用。
  • description: ?String - 标签描述。

var name

cangjie
public var name: ?String = None

功能:表示标签名称。

类型:?String

var description

cangjie
public var description: ?String = None

功能:表示标签描述。

类型:?String

var reference

cangjie
public var reference: ?OpenApiReference = None

功能:表示标签引用。

类型:?OpenApiReference

func serializeAsV3(IOpenApiWriter)

cangjie
public func serializeAsV3(writer: IOpenApiWriter): Unit

功能:按 OpenAPI V3 格式写出当前标签对象。

参数:

返回值:

  • Unit