Skip to content

class OpenApiPathItem

cangjie
public class OpenApiPathItem <: IOpenApiSerializable

功能:表示 OpenAPI 路径项对象。

父类型:

成员概览

成员功能
init()创建 OpenAPI 路径项对象。
var summary表示路径项摘要。
var description表示路径项描述。
var unresolvedReference表示当前路径项是否未解析引用。
var reference表示路径项引用。
var servers表示路径项服务器集合。
var parameters表示路径项参数集合。
var operations表示路径项操作集合。
func serializeAsV3(IOpenApiWriter)按 OpenAPI V3 格式写出当前路径项对象。

init()

cangjie
public init()

功能:创建 OpenAPI 路径项对象。

var summary

cangjie
public var summary: ?String = None

功能:表示路径项摘要。

类型:?String

var description

cangjie
public var description: ?String = None

功能:表示路径项描述。

类型:?String

var unresolvedReference

cangjie
public var unresolvedReference: Bool = false

功能:表示当前路径项是否未解析引用。

类型:Bool

var reference

cangjie
public var reference: ?OpenApiReference = None

功能:表示路径项引用。

类型:?OpenApiReference

var servers

cangjie
public var servers = ArrayList<OpenApiServer>()

功能:表示路径项服务器集合。

var parameters

cangjie
public var parameters = ArrayList<OpenApiParameter>()

功能:表示路径项参数集合。

var operations

cangjie
public var operations = HashMap<OperationType, OpenApiOperation>()

功能:表示路径项操作集合。

func serializeAsV3(IOpenApiWriter)

cangjie
public func serializeAsV3(writer: IOpenApiWriter): Unit

功能:按 OpenAPI V3 格式写出当前路径项对象。

参数:

返回值:

  • Unit