https://github.com/holgerbrandl/jsonbuilder
A small artefact to build json with kotlin
https://github.com/holgerbrandl/jsonbuilder
dsl json kotlin
Last synced: 4 months ago
JSON representation
A small artefact to build json with kotlin
- Host: GitHub
- URL: https://github.com/holgerbrandl/jsonbuilder
- Owner: holgerbrandl
- License: bsd-2-clause
- Created: 2019-04-04T07:06:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-01T13:18:35.000Z (almost 3 years ago)
- Last Synced: 2025-06-03T07:51:39.927Z (4 months ago)
- Topics: dsl, json, kotlin
- Language: Kotlin
- Size: 77.1 KB
- Stars: 19
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# jsonbuilder for Kotlin
`jsonbuilder` is a small artifact that serves a single purpose: It allows to create json using an idiomatic [kotlin](https://kotlinlang.org/) builder DSL.
## Example
```
val myJson = json {
"size" to 0
"array" to arrayOf(1,2,3)
"aggs" to {
"num_destinations" to {
"cardinality" to {
"field" to "DestCountry"
}
}
}
}
```
which will result in the following json structure:
```
{
"size": 0,
"array": [
1,
2,
3
],
"aggs": {
"num_destinations": {
"cardinality": {
"field": "DestCountry"
}
}
}
}
```
Both arrays and nested elements are supported without additional functions/constructs.
## Setup
### Gradle
To get started simply add it as a dependency in your `build.gradle`:
```
compile "com.github.holgerbrandl:jsonbuilder:0.10"
```
### Development Snapshots
You can also use [JitPack with Maven or Gradle](https://jitpack.io/#holgerbrandl/jsonbuilder) to build the latest snapshot as a dependency in your project.
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compile 'com.github.holgerbrandl:jsonbuilder:-SNAPSHOT'
}
```
### How to build?
To build and install it into your local maven cache, simply clone the repo and run
```bash
./gradlew install
```
## Documentation
This `README.md`. Feel welcome to file tickets about missing pieces in the docs.
## How to contribute?
Feel welcome to post ideas, suggestions and criticism to our [tracker](https://github.com/holgerbrandl/jsonbuilder/issues).
We always welcome pull requests. :-)
You could also show your spiritual support by just upvoting `jsonbuilder` here on github.
## References
This library is built using https://github.com/stleary/JSON-java
Other references
* https://stackoverflow.com/questions/41861449/kotlin-dsl-for-creating-json-objects-without-creating-garbage
* https://github.com/SalomonBrys/Kotson
*