Generates JSON schemas from `@Serializable` types using `kotlinx.serialization`, avoiding runtime reflection. Compatible with multiple platforms, with certain platform exclusions.
This library uses kotlinx.serialization to generate a JSON schema from a @Serializable type.
This library uses SerialDescriptor to get the structure of schema. No runtime reflection cost.
This library support Kotlin/multiplatform. Because the author Stream only have a Windows laptop, the following targets are not built and published: iosArm64, iosSimulatorArm64, iosX64, macosArm64, macosX64, tvosArm64, tvosSimulatorArm64, tvosX64, watchosArm32, watchosArm64, watchosDeviceArm64, watchosSimulatorArm64, watchosX64
Please mention that on Kotlin/JS, the string expression of float numbers may be different.
2.0d may be shown in 2 and that may cause some unit tests fail.
This library is published on Maven Central. Add the following dependency to your build.gradle.kts:
implementation("io.github.stream29:json-schema-generator:<version>")
Please mention that this library will also include kotlinx.serialization-json as a api dependency.
To quickly learn the usage of this library, see Kotlin Notebook.
This library uses kotlinx.serialization to generate a JSON schema from a @Serializable type.
This library uses SerialDescriptor to get the structure of schema. No runtime reflection cost.
This library support Kotlin/multiplatform. Because the author Stream only have a Windows laptop, the following targets are not built and published: iosArm64, iosSimulatorArm64, iosX64, macosArm64, macosX64, tvosArm64, tvosSimulatorArm64, tvosX64, watchosArm32, watchosArm64, watchosDeviceArm64, watchosSimulatorArm64, watchosX64
Please mention that on Kotlin/JS, the string expression of float numbers may be different.
2.0d may be shown in 2 and that may cause some unit tests fail.
This library is published on Maven Central. Add the following dependency to your build.gradle.kts:
implementation("io.github.stream29:json-schema-generator:<version>")
Please mention that this library will also include kotlinx.serialization-json as a api dependency.
To quickly learn the usage of this library, see Kotlin Notebook.