Skip to content

class OpenApiRequestBody

cangjie
public class OpenApiRequestBody <: IOpenApiSerializable

功能:表示 OpenAPI 请求体对象。

父类型:

成员概览

成员功能
init(Bool, ?String)创建 OpenAPI 请求体对象。
var required表示请求体是否必填。
var description表示请求体描述。
var content表示请求体内容映射。
func serializeAsV3(IOpenApiWriter)按 OpenAPI V3 格式写出当前请求体对象。

init(Bool, ?String)

cangjie
public init(required!: Bool = false, description!: ?String = None)

功能:创建 OpenAPI 请求体对象。

参数:

  • required: Bool - 请求体是否必填。
  • description: ?String - 请求体描述。

var required

cangjie
public var required: Bool = false

功能:表示请求体是否必填。

类型:Bool

var description

cangjie
public var description: ?String = None

功能:表示请求体描述。

类型:?String

var content

cangjie
public var content = HashMap<String, OpenApiMediaType>()

功能:表示请求体内容映射。

func serializeAsV3(IOpenApiWriter)

cangjie
public func serializeAsV3(writer: IOpenApiWriter): Unit

功能:按 OpenAPI V3 格式写出当前请求体对象。

参数:

返回值:

  • Unit