Skip to content

Modules Overview

Lukas Ruegner edited this page Jun 8, 2024 · 8 revisions

The schema-kenerator project is split into multiple libraries. Modules usually provide steps with additional functionality.


Core

Contains the core data models as well as some common steps and annotations.

dependencies {
    implementation "io.github.smiley4:schema-kenerator-core:<VERSION>"
}

More information and included steps can be found here.


Reflection

This project provides steps and annotations to extract and modify information from kotlin types using reflection.

dependencies {
    implementation "io.github.smiley4:schema-kenerator-reflection:<VERSION>"
}

More information and included steps can be found here.


Kotlinx-Serialization

This project provides steps to extract and modify information from kotlin types using kotlinx-serialization.

dependencies {
    implementation "io.github.smiley4:schema-kenerator-serialization:<VERSION>"
}

More information and included steps can be found here.


Jackson

This project provides common steps to support Jackson-annotations.

dependencies {
    implementation "io.github.smiley4:schema-kenerator-jackson:<VERSION>"
}

More information and included steps can be found here.


Jackson JSON-Schema

This project provides steps to support Jackson-annotations specific to JSON-schema generation.

dependencies {
    implementation "io.github.smiley4:schema-kenerator-jackson-jsonschema:<VERSION>"
}

More information and included steps can be found here.


Jackson Swagger

This project provides steps to support Jackson-annotations specific to Swagger-schema generation.

dependencies {
    implementation "io.github.smiley4:schema-kenerator-jackson-swagger:<VERSION>"
}

More information and included steps can be found here.


JsonSchema

This project provides steps and annotations to create JSON-Schema from type data and to customize the generated schema.

dependencies {
    implementation "io.github.smiley4:schema-kenerator-jsonschema:<VERSION>"
}

More information and included steps can be found here


Swagger

This project provides steps and annotations to create Swagger-Schema from type data and to customize the generated schema.

dependencies {
    implementation "io.github.smiley4:schema-kenerator-swagger:<VERSION>"
}

More information and included steps can be found here.