Skip to content

class OpenApiOptions

cangjie
public class OpenApiOptions

功能:定义 OpenAPI 文档生成选项。

成员概览

成员功能
var createSchemaReferenceId确定指定类型在 components/schemas 中使用的引用 ID。
func addDocumentTransformer(IOpenApiDocumentTransformer)添加文档转换器实例。
func addDocumentTransformer((OpenApiDocument, OpenApiDocumentTransformerContext) -> Unit)以委托形式添加文档转换器。
func addOperationTransformer(IOpenApiOperationTransformer)添加操作转换器实例。
func addOperationTransformer((OpenApiOperation, OpenApiOperationTransformerContext) -> Unit)以委托形式添加操作转换器。
func addSchemaTransformer(IOpenApiSchemaTransformer)添加架构转换器实例。
func addSchemaTransformer((OpenApiSchema, OpenApiSchemaTransformerContext) -> Unit)以委托形式添加架构转换器。

var createSchemaReferenceId

cangjie
public var createSchemaReferenceId: (TypeInfo) -> ?String =

功能:确定指定类型在 components/schemas 中使用的引用 ID。

返回 None 时该 Schema 始终内联,不生成 $ref。

类型:(TypeInfo) -> ?String

func addDocumentTransformer(IOpenApiDocumentTransformer)

cangjie
public func addDocumentTransformer(transformer: IOpenApiDocumentTransformer): Unit

功能:添加文档转换器实例。

参数:

返回值:

  • Unit

func addDocumentTransformer((OpenApiDocument, OpenApiDocumentTransformerContext) -> Unit)

cangjie
public func addDocumentTransformer(transformer: (OpenApiDocument, OpenApiDocumentTransformerContext) -> Unit): Unit

功能:以委托形式添加文档转换器。

参数:

返回值:

  • Unit

func addOperationTransformer(IOpenApiOperationTransformer)

cangjie
public func addOperationTransformer(transformer: IOpenApiOperationTransformer): Unit

功能:添加操作转换器实例。

参数:

返回值:

  • Unit

func addOperationTransformer((OpenApiOperation, OpenApiOperationTransformerContext) -> Unit)

cangjie
public func addOperationTransformer(transformer: (OpenApiOperation, OpenApiOperationTransformerContext) -> Unit): Unit

功能:以委托形式添加操作转换器。

参数:

返回值:

  • Unit

func addSchemaTransformer(IOpenApiSchemaTransformer)

cangjie
public func addSchemaTransformer(transformer: IOpenApiSchemaTransformer): Unit

功能:添加架构转换器实例。

参数:

返回值:

  • Unit

func addSchemaTransformer((OpenApiSchema, OpenApiSchemaTransformerContext) -> Unit)

cangjie
public func addSchemaTransformer(transformer: (OpenApiSchema, OpenApiSchemaTransformerContext) -> Unit): Unit

功能:以委托形式添加架构转换器。

参数:

返回值:

  • Unit