SerializationClassJsonSchemaGenerator
class SerializationClassJsonSchemaGenerator(json: Json = Json.Default, introspectorConfig: SerializationClassSchemaIntrospector.Config = SerializationClassSchemaIntrospector.Config(), jsonSchemaConfig: JsonSchemaConfig = JsonSchemaConfig.Default) : AbstractSchemaGenerator<SerialDescriptor, JsonSchema, SerializationClassSchemaIntrospector.Config> (source)
A generator for producing JSON Schema representations from kotlinx.serialization descriptors.
This class utilizes kotlinx.serialization introspection to analyze SerialDescriptor instances and generate JSON Schema objects. It is built on top of the AbstractSchemaGenerator and works with a configurable JsonSchemaConfig to define schema generation behavior.
Parameters
json
The Json instance used for serializing schema objects.
introspectorConfig
Configuration for introspecting serial descriptors.
jsonSchemaConfig
Configuration for generating JSON Schemas, such as formatting details and handling of optional nullable properties. Defaults to JsonSchemaConfig.Default.
Constructors
Link copied to clipboard
constructor(json: Json = Json.Default, introspectorConfig: SerializationClassSchemaIntrospector.Config = SerializationClassSchemaIntrospector.Config(), jsonSchemaConfig: JsonSchemaConfig = JsonSchemaConfig.Default)
Creates an instance of SerializationClassJsonSchemaGenerator.