There are special use cases that each language supports; this document pertains to Kotlin models.
Since data classes
are used for every model that has properties, there is no need for additional settings or
features to generate toString()
, equals()
, hashCode()
, getters or setters.
Classes without properties are depicted by usual classes
, they get no toString()
, equals()
, or hashCode()
implementation. The default one should suffice here.
- Include KDoc for properties
- Change the collection type for arrays
- Include Javax validation constraint annotations for properties
- Generate serializer and deserializer functionality
To generate models containing KDoc
from description and examples, use the KOTLIN_DESCRIPTION_PRESET
option.
Check out this example for a live demonstration.
Sometimes, we might want to render a different collection type, and instead of the default Array
use it as a List
type. To do so, provide the option collectionType: 'List'
.
Check out this example for a live demonstration.
In some cases, when you generate the models from JSON Schema, you may want to include javax.validation.constraint
annotations.
Check out this example for a live demonstration.
The most widely used use case for Modelina is to generate models that include serialization and deserialization functionality to convert the models into payload data. This payload data can of course be many kinds, JSON, XML, raw binary, you name it.
As you normally only need one library to do this, we developers can never get enough with creating new stuff, therefore there might be one specific library you need or want to integrate with. Therefore, there is not one specific preset that offers everything. Below is a list of all the supported serialization presets.
Currently not supported, let everyone know you need it!
Currently not supported, let everyone know you need it!
Currently not supported, let everyone know you need it!