Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smiley4/schema-kenerator
Analyze kotlin types, extract information and generate schemas
https://github.com/smiley4/schema-kenerator
json-schema kotlin kotlinx-serialization openapi reflection schema swagger
Last synced: 1 day ago
JSON representation
Analyze kotlin types, extract information and generate schemas
- Host: GitHub
- URL: https://github.com/smiley4/schema-kenerator
- Owner: SMILEY4
- License: apache-2.0
- Created: 2023-12-09T07:47:25.000Z (11 months ago)
- Default Branch: develop
- Last Pushed: 2024-05-19T13:02:04.000Z (6 months ago)
- Last Synced: 2024-05-19T14:23:44.628Z (6 months ago)
- Topics: json-schema, kotlin, kotlinx-serialization, openapi, reflection, schema, swagger
- Language: Kotlin
- Homepage:
- Size: 505 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Schema-Kenerator
[](https://search.maven.org/search?q=g:io.github.smiley4%20a:schema-kenerator-*)
[](https://github.com/SMILEY4/schema-kenerator/actions/workflows/checks.yml)
Kotlin library to extract information from classes using reflection or kotlinx-serialization and generate schemas like json-schema or swagger-schemas from the resulting information.
## Features
- extract information from classes using reflection or kotlinx-serialization
- supports nested types, inheritance, generics, annotations
- generate json-schema or [swagger](https://github.com/swagger-api/swagger-parser)-schema
- add metadata using additional annotations (title, description, deprecation, subtypes, ...)
- supports annotations from Jackson, Swagger, Javax-Validations and Jakarta-Validations
- customizable and extendable
## Installation
```kotlin
dependencies {
implementation("io.github.smiley4:schema-kenerator-core:")
// only for using reflection
implementation("io.github.smiley4:schema-kenerator-reflection:")
// only for using kotlinx-serialization
implementation("io.github.smiley4:schema-kenerator-serialization:")
// only for generating json-schemas
implementation("io.github.smiley4:schema-kenerator-jsonschema:")
// only for generating swagger-schemas
implementation("io.github.smiley4:schema-kenerator-swagger:")
// only for support of Jackson-annotations
implementation("io.github.smiley4:schema-kenerator-jackson:")
// only for support of javax and jakarta validation-annotations for swagger-schemas
implementation("io.github.smiley4:schema-kenerator-validations-swagger:")
}
```
## Documentation
Examples showcasing and explaining the functionalities and use cases of this project can be found [here](https://github.com/SMILEY4/schema-kenerator/tree/develop/schema-kenerator-examples/src/test/kotlin/io/github/smiley4/schemakenerator/examples).
A wiki with documentation is available [here](https://github.com/SMILEY4/schema-kenerator/wiki).
## Concept Overview
Data extraction and schema generation happens in several steps that can be grouped into the following phases:
1. Information extraction
1. collect relevant types that need to be analyzed
2. process types, i.e. extract information from each type and nested types
3. enrich and modify extracted type data, e.g. with annotations
2. Schema generation
1. generate individual schema for each type (and nested type)
2. enrich and modify generated schemas, e.g. using annotations
3. compile individual schemas into one final schema, either inlining all types or properly referencing them
Schema-Kenerator provides independent steps for each phase that can be chained together to achieve the desired result.
## Example (json-schema & reflection)
```kotlin
class MyExampleClass(
val someText: String,
val someNullableInt: Int?,
val someBoolList: List,
)
```
```kotlin
val jsonSchema = typeOf()
.processReflection()
.generateJsonSchema()
.withTitle(TitleType.SIMPLE)
.compileInlining()
.json
.prettyPrint()
```
```json
{
"type": "object",
"title": "MyExampleClass",
"required": [ "someBoolList", "someText" ],
"properties": {
"someBoolList": {
"type": "array",
"title": "List",
"items": {
"type": "boolean",
"title": "Boolean"
}
},
"someNullableInt": {
"type": "integer",
"title": "Int",
"minimum": -2147483648,
"maximum": 2147483647
},
"someText": {
"type": "string",
"title": "String"
}
}
}
```
## Example (swagger & kotlinx-serialization)
```kotlin
dependencies {
implementation("io.github.smiley4:schema-kenerator-core:")
implementation("io.github.smiley4:schema-kenerator-serialization:")
implementation("io.github.smiley4:schema-kenerator-swagger:")
}
```
```kotlin
@Serializable
class MyExampleClass(
val someText: String,
val someNullableInt: Int?,
val someBoolList: List,
)
```
```kotlin
val swaggerSchema: Schema<*> = typeOf()
.processKotlinxSerialization()
.generateSwaggerSchema()
.withTitle(TitleType.SIMPLE)
.compileInlining()
.swagger
```
```json
{
"title" : "MyExampleClass",
"required" : [ "someBoolList", "someText" ],
"type" : "object",
"properties" : {
"someText" : {
"title" : "String",
"type" : "string",
"exampleSetFlag" : false
},
"someNullableInt" : {
"title" : "Int",
"type" : "integer",
"format" : "int32",
"exampleSetFlag" : false
},
"someBoolList" : {
"title" : "ArrayList",
"type" : "array",
"exampleSetFlag" : false,
"items" : {
"title" : "Boolean",
"type" : "boolean",
"exampleSetFlag" : false
}
}
},
"exampleSetFlag" : false
}
```