OpenAPISchemaBuilder

class OpenAPISchemaBuilder(schemaVersion: SchemaVersion = SchemaVersion.DRAFT_2020_12, optionPreset: OptionPreset = OptionPreset.PLAIN_JSON, val defaultSchemaNamePrefix: String = "", customizer: Consumer<SchemaGeneratorConfigBuilder> = DefaultCustomizer(defaultSchemaNamePrefix), openapi31: Boolean = true) : DefaultSchemaNamePrefixCapable, InlineSchemaCapable

Constructors

Link copied to clipboard
constructor(schemaVersion: SchemaVersion = SchemaVersion.DRAFT_2020_12, optionPreset: OptionPreset = OptionPreset.PLAIN_JSON, defaultSchemaNamePrefix: String = "", customizer: Consumer<SchemaGeneratorConfigBuilder> = DefaultCustomizer(defaultSchemaNamePrefix), openapi31: Boolean = true)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
class DefaultCustomizer(val defaultSchemaNamePrefix: String = "") : DefaultSchemaNamePrefixCapable, Consumer<SchemaGeneratorConfigBuilder>
Link copied to clipboard
class InlineCustomizer(val defaultSchemaNamePrefix: String = "") : DefaultSchemaNamePrefixCapable, Consumer<SchemaGeneratorConfigBuilder>
Link copied to clipboard
data class SchemaReference(val type: ResolvedType, val schema: Schema<*>, val node: ObjectNode)

Properties

Link copied to clipboard
open override val defaultSchemaNamePrefix: String
Link copied to clipboard
open override val inline: Boolean

Functions

Link copied to clipboard
fun build(): Map<String, Schema<*>>
Link copied to clipboard
fun generateSchema(mainTargetType: Type, vararg typeParameters: Type): Schema<*>
Link copied to clipboard
fun resolveType(mainTargetType: Type, vararg typeParameters: Type): ResolvedType