-
Notifications
You must be signed in to change notification settings - Fork 6
Modules Overview
The schema-kenerator project is split into multiple libraries. Modules usually provide steps with additional functionality.
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.
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.
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.
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.
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.
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.
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
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.
- Installation
- Modules Overview
- Examples with Explanations
- General Concept
- Custom Type Processing
- Type Redirects
- Generating a Json-Schema using Reflection
- Generating a Swagger-schema using Kotlinx-Serialization
-
How To...
- ... add additional information like title and description to schemas?
- ... use 'toString' or 'name' for enum constants?
- ... overwrite specific types with custom data?
- ... give schemas a different name instead of using the name of the type?
- ... configure class property filters to include or exclude e.g. getter-functions, private or static fields?
- ... detect and handle subtypes and supertypes?
- Changelog