This folder contains various samples of setup and usage of kotlinx.serialization library, namely:
Provides setup for multiplatform library with kotlinx.serialization on JVM, JS and Native targets using new multiplatform model from Kotlin 1.3 ('kotlin-multiplatform' plugin). Also features how one can setup tests for JS.
Provides setup for Gradle and Maven build systems for JVM target. Contains examples of implementing your own formats.
To launch this sample with Maven, use mvn package exec:java within example-jvm folder.
Provides setup for Gradle using 'kotlin2js' plugin. Contains examples of using different formats (JSON, CBOR, Protobuf).
To launch this sample, first run ./gradlew build and then point your browser to example-js/web/index.html.
Provides setup for Gradle using 'kotlin-platform-native' plugin and Gradle metadata (Gradle 4.8+ required, used one is 4.10).
Provides setup for Gradle using Kotlin Gradle DSL and 'kotlin.jvm' plugin. Showcases how one can use functionality of visiting serializable class descriptors tree to extract different metadata from the class, e.g. Json schema or .proto definition.
You can use ./gradlew run to run all samples or ./gradlew :folder-name:run to run a particular sample.
All samples are subprojects of the kotlinx-serialization-examples project, located in this folder. Just import the build.gradle file into IDEA.
Feel free to copy-paste any particular sample you need. Copy folder with sample and its build.gradle; you can also take the gradle.properties file from this folder, since it provides project properties with kotlin & serialization versions. For example-multiplatform and example-visitors you may also need pluginManagement block from settings.gradle.