Spire 天擎

外观

class OpenApiParameter ​

cangjie
public class OpenApiParameter <: IOpenApiSerializable

功能：表示 OpenAPI 参数对象。

父类型：

成员概览 ​

成员功能
init(?String, ?ParameterLocation, ?String, ?Bool, ?Bool, ?OpenApiSchema)创建 OpenAPI 参数对象。
var name表示参数名称。
var required表示参数是否必填。
var deprecated表示参数是否已弃用。
var description表示参数描述。
var schema表示参数架构。
var location表示参数位置。
func serializeAsV3(IOpenApiWriter)按 OpenAPI V3 格式写出当前参数对象。

init(?String, ?ParameterLocation, ?String, ?Bool, ?Bool, ?OpenApiSchema) ​

cangjie
public init(name!: ?String, location!: ?ParameterLocation = None, description!: ?String = None,
required!: ?Bool = None, deprecated!: ?Bool = None, schema!: ?OpenApiSchema = None)

功能：创建 OpenAPI 参数对象。

参数：

  • name: ?String - 参数名称。
  • location: ?ParameterLocation - 参数位置。
  • description: ?String - 参数描述。
  • required: ?Bool - 参数是否必填。
  • deprecated: ?Bool - 参数是否已弃用。
  • schema: ?OpenApiSchema - 参数架构。

var name ​

cangjie
public var name: ?String

功能：表示参数名称。

类型：?String

var required ​

cangjie
public var required: ?Bool

功能：表示参数是否必填。

类型：?Bool

var deprecated ​

cangjie
public var deprecated: ?Bool

功能：表示参数是否已弃用。

类型：?Bool

var description ​

cangjie
public var description: ?String

功能：表示参数描述。

类型：?String

var schema ​

cangjie
public var schema: ?OpenApiSchema = None

功能：表示参数架构。

类型：?OpenApiSchema

var location ​

cangjie
public var location: ?ParameterLocation = None

功能：表示参数位置。

类型：?ParameterLocation

func serializeAsV3(IOpenApiWriter) ​

cangjie
public func serializeAsV3(writer: IOpenApiWriter): Unit

功能：按 OpenAPI V3 格式写出当前参数对象。

参数：

返回值：

  • Unit