class OpenApiOptions
cangjie
public class OpenApiOptions功能:定义 OpenAPI 文档生成选项。
成员概览
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功能:添加文档转换器实例。
参数:
- transformer: IOpenApiDocumentTransformer - 要添加的 OpenAPI 文档转换器。
返回值:
Unit
func addDocumentTransformer((OpenApiDocument, OpenApiDocumentTransformerContext) -> Unit)
cangjie
public func addDocumentTransformer(transformer: (OpenApiDocument, OpenApiDocumentTransformerContext) -> Unit): Unit功能:以委托形式添加文档转换器。
参数:
- transformer: (OpenApiDocument, OpenApiDocumentTransformerContext) -> Unit - 表示文档转换逻辑的委托。
返回值:
Unit
func addOperationTransformer(IOpenApiOperationTransformer)
cangjie
public func addOperationTransformer(transformer: IOpenApiOperationTransformer): Unit功能:添加操作转换器实例。
参数:
- transformer: IOpenApiOperationTransformer - 要添加的 OpenAPI 操作转换器。
返回值:
Unit
func addOperationTransformer((OpenApiOperation, OpenApiOperationTransformerContext) -> Unit)
cangjie
public func addOperationTransformer(transformer: (OpenApiOperation, OpenApiOperationTransformerContext) -> Unit): Unit功能:以委托形式添加操作转换器。
参数:
- transformer: (OpenApiOperation, OpenApiOperationTransformerContext) -> Unit - 表示操作转换逻辑的委托。
返回值:
Unit
func addSchemaTransformer(IOpenApiSchemaTransformer)
cangjie
public func addSchemaTransformer(transformer: IOpenApiSchemaTransformer): Unit功能:添加架构转换器实例。
参数:
- transformer: IOpenApiSchemaTransformer - 要添加的 OpenAPI 架构转换器。
返回值:
Unit
func addSchemaTransformer((OpenApiSchema, OpenApiSchemaTransformerContext) -> Unit)
cangjie
public func addSchemaTransformer(transformer: (OpenApiSchema, OpenApiSchemaTransformerContext) -> Unit): Unit功能:以委托形式添加架构转换器。
参数:
- transformer: (OpenApiSchema, OpenApiSchemaTransformerContext) -> Unit - 表示架构转换逻辑的委托。
返回值:
Unit