Skip to content

class OpenApiReference

cangjie
public class OpenApiReference <: IOpenApiSerializable

功能:表示 OpenAPI 引用对象。

父类型:

成员概览

成员功能
init(ReferenceType, String)创建 OpenAPI 引用对象。
var id表示引用标识。
var referenceType表示引用类型。
func toReferenceString()返回当前引用在 OpenAPI 文档中的字符串值。
func serializeAsV3(IOpenApiWriter)按 OpenAPI V3 格式写出当前引用对象。

init(ReferenceType, String)

cangjie
public init(referenceType: ReferenceType, id: String)

功能:创建 OpenAPI 引用对象。

参数:

  • referenceType: ReferenceType - 引用类型。
  • id: String - 引用标识。

var id

cangjie
public var id: String

功能:表示引用标识。

类型:String

var referenceType

cangjie
public var referenceType: ReferenceType

功能:表示引用类型。

类型:ReferenceType

func toReferenceString()

cangjie
public func toReferenceString(): String

功能:返回当前引用在 OpenAPI 文档中的字符串值。

返回值:

  • String - 引用字符串。

func serializeAsV3(IOpenApiWriter)

cangjie
public func serializeAsV3(writer: IOpenApiWriter): Unit

功能:按 OpenAPI V3 格式写出当前引用对象。

参数:

返回值:

  • Unit