wow-schema/me.ahoo.wow.schema/SchemaGeneratorBuilder

SchemaGeneratorBuilder

Builder class for constructing a SchemaGenerator with customizable modules and options. This builder allows configuration of various JSON schema generation modules including Jackson, Jakarta Validation, Swagger2, Kotlin, Joda Money, and Wow-specific modules.

Constructors

constructor()

Types

Companion

object Companion

Properties

customizer

var customizer: Consumer<SchemaGeneratorConfigBuilder>?

jacksonModule

var jacksonModule: JacksonModule?

Jackson module for handling Jackson annotations in schema generation.

jakartaValidationModule

var jakartaValidationModule: JakartaValidationModule?

jodaMoneyModule

var jodaMoneyModule: JodaMoneyModule?

kotlinModule

var kotlinModule: KotlinModule?

openapi31

var openapi31: Boolean

Whether to use OpenAPI 3.1 specification.

optionPreset

var optionPreset: OptionPreset

The preset of options to apply to the schema generator.

options

var options: List<Option>

requiredTypeContent

val requiredTypeContent: TypeContext

Gets the TypeContext after build() has been called. Throws if not built yet.

schemaNamingModule

var schemaNamingModule: SchemaNamingModule?

schemaVersion

var schemaVersion: SchemaVersion

The JSON Schema version to use for generation.

swagger2Module

var swagger2Module: Swagger2Module?

typeContext

var typeContext: TypeContext?

wowModule

var wowModule: WowModule?

Functions

build

fun build(): SchemaGenerator

Builds and returns a SchemaGenerator instance with the configured modules and options. This method must be called before accessing requiredTypeContent.

customizer