Spire 天擎

外观

class OpenApiSchema ​

cangjie
public class OpenApiSchema <: IOpenApiSerializable

功能：表示 OpenAPI 架构对象。

父类型：

成员概览 ​

成员功能
init(?String, ?Bool, ?String, ?OpenApiSchema, ?String, ?OpenApiReference, ?String)创建 OpenAPI 架构对象。
var title表示架构标题。
var nullable表示架构是否可为空。
var type表示架构类型。
var items表示数组元素架构。
var format表示架构格式。
var description表示架构描述。
var reference表示架构引用。
var properties表示对象属性集合。
var allOf表示 allOf 组合架构。
var additionalProperties表示是否允许附加属性。
var additionalPropertiesSchema表示附加属性的值架构。
func serializeAsV3(IOpenApiWriter)按 OpenAPI V3 格式写出当前架构对象。

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

cangjie
public init(title!: ?String = None, nullable!: ?Bool = None, `type`!: ?String = None, items!: ?OpenApiSchema = None,
format!: ?String = None, reference!: ?OpenApiReference = None, description!: ?String = None)

功能：创建 OpenAPI 架构对象。

参数：

  • title: ?String - 架构标题。
  • nullable: ?Bool - 架构是否可为空。
  • type: ?String - 架构类型。
  • items: ?OpenApiSchema - 数组元素架构。
  • format: ?String - 架构格式。
  • reference: ?OpenApiReference - 架构引用。
  • description: ?String - 架构描述。

var title ​

cangjie
public var title: ?String = None

功能：表示架构标题。

类型：?String

var nullable ​

cangjie
public var nullable: ?Bool = None

功能：表示架构是否可为空。

类型：?Bool

var type ​

cangjie
public var `type`: ?String = None

功能：表示架构类型。

类型：?String

var items ​

cangjie
public var items: ?OpenApiSchema = None

功能：表示数组元素架构。

类型：?OpenApiSchema

var format ​

cangjie
public var format: ?String = None

功能：表示架构格式。

类型：?String

var description ​

cangjie
public var description: ?String = None

功能：表示架构描述。

类型：?String

var reference ​

cangjie
public var reference: ?OpenApiReference = None

功能：表示架构引用。

类型：?OpenApiReference

var properties ​

cangjie
public var properties = HashMap<String, OpenApiSchema>()

功能：表示对象属性集合。

var allOf ​

cangjie
public var allOf = ArrayList<OpenApiSchema>()

功能：表示 allOf 组合架构。

var additionalProperties ​

cangjie
public var additionalProperties: ?Bool = None

功能：表示是否允许附加属性。

类型：?Bool

var additionalPropertiesSchema ​

cangjie
public var additionalPropertiesSchema: ?OpenApiSchema = None

功能：表示附加属性的值架构。

类型：?OpenApiSchema

func serializeAsV3(IOpenApiWriter) ​

cangjie
public func serializeAsV3(writer: IOpenApiWriter): Unit

功能：按 OpenAPI V3 格式写出当前架构对象。

参数：

返回值：

  • Unit