Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wuseal/JsonToKotlinClass
🚀 Plugin for Android Studio And IntelliJ Idea to generate Kotlin data class code from JSON text ( Json to Kotlin )
https://github.com/wuseal/JsonToKotlinClass
android-studio-plugin androidstudio-plugin fastjson gson intellij-plugin jackson json-to-kotlin kotlin logansquare moshi
Last synced: about 2 months ago
JSON representation
🚀 Plugin for Android Studio And IntelliJ Idea to generate Kotlin data class code from JSON text ( Json to Kotlin )
- Host: GitHub
- URL: https://github.com/wuseal/JsonToKotlinClass
- Owner: wuseal
- License: gpl-3.0
- Created: 2017-08-29T03:28:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T15:09:32.000Z (9 months ago)
- Last Synced: 2024-04-14T01:04:46.411Z (8 months ago)
- Topics: android-studio-plugin, androidstudio-plugin, fastjson, gson, intellij-plugin, jackson, json-to-kotlin, kotlin, logansquare, moshi
- Language: Kotlin
- Homepage:
- Size: 7.59 MB
- Stars: 3,004
- Watchers: 34
- Forks: 171
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin - JsonToKotlinClass - 🚀Plugin for Android Studio And IntelliJ Idea to generate Kotlin data class code from JSON text ( Json to Kotlin ) (Libraries)
- awesome-list - wuseal/JsonToKotlinClass - 🚀 Plugin for Android Studio And IntelliJ Idea to generate Kotlin data class code from JSON text ( Json to Kotlin ) (Kotlin)
README
[](https://github.com/wuseal/JsonToKotlinClass/actions/workflows/main.yml)
[](https://github.com/wuseal/JsonToKotlinClass/releases)
[](https://github.com/wuseal/JsonToKotlinClass/stargazers)
[](https://plugins.jetbrains.com/plugin/9960-jsontokotlinclass)
[](https://github.com/wuseal/JsonToKotlinClass/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/wuseal/JsonToKotlinClass/blob/master/LICENSE)
[](https://kotlinlang.org/)
[](https://plugins.jetbrains.com/plugin/9960-jsontokotlinclass)
[](https://plugins.jetbrains.com/plugin/9960-jsontokotlinclass)
# JsonToKotlinClass
Hi, Welcome! This is a plugin to generate Kotlin `data class` from JSON string, in another word, a plugin that converts JSON string to Kotlin `data class` (Json to Kotlin).
We also have a `Java/Kotlin` [library](doc/LIBRARY.md). With this you can generate Kotlin `data class` from JSON string **programmatically**.
```groovy
implementation 'com.sealwu.jsontokotlin:library:3.7.4'
```
### Overview
This is a very cool tool for Kotlin developers, it can convert a JSON string to Kotlin `data class`. The tool could not only recognize the primitive types but also auto create complex types. It's easily accessible, we provide shortcut keymap `ALT + K` for Windows and `Option + K` for Mac, have a try and you'll fall in love with it! JsonToKotlinClass just makes programming more enjoyable, enjoy coding!
[](https://www.youtube.com/watch?v=lSBvHOIDAjc)
### Easy Use
#### Want to generate classes code in inner class model? Do like this.
#### Want to generate Kotlin data class file? Do like this.
#### Want to generate Kotlin data classes in single file? Do like this.
### Usage
* Search 'JsonToKotlinClass' in Intellij Idea Plugin Repository Or AndroidStudio Plugin Repository And Install it.
> File --> Settings --> Plugins --> Browse Repositories --> Search JsonToKotlinClass
* Restart your IDE
* Press `ALT + K` for Windows or `Option + K` for Mac or right click on package -> `New`->`Kotlin data clas file from JSON` and continue as guided.
### Advanced usage
Have a try with the advanced dialog :stuck_out_tongue_winking_eye:
### Features
* Generating Kotlin data class from any legal JSON string/JSONSchema or any **URLs that returns a JSON string/JSONSchema as response** or **local file that contains JSON string/JSONSchema**, for more detail about supported source types, refer to [the documentation](https://github.com/wuseal/JsonToKotlinClass/blob/master/doc/doc_for_json_sources.md)
* Generating Kotlin data class from any legal JSON text when right click on directory and select `New` -> `Kotlin data class File from JSON`
* Supporting (almostly) all kinds of JSON libs' annotation(Gson, Jackson, Fastjson, MoShi and LoganSquare, kotlinx.serialization(default custom value))
* [Customizing your own annotations](https://github.com/wuseal/JsonToKotlinClass/issues/19)
* [Initializing properties with default values](https://github.com/wuseal/JsonToKotlinClass/issues/6)
* Allowing properties to be nullable(?)
* [Determining property nullability automatically](https://github.com/wuseal/JsonToKotlinClass/issues/23)
* Renaming property names to be camelCase style when selecting a target JSON lib annotation．
* Generating Kotlin `data class` as individual classes
* Generating Kotlin `data class` as inner classes
* [Formatting any legal JSON string](https://github.com/wuseal/JsonToKotlinClass/issues/18)
* Generating Map Type when json key is primitive type
* [Android Parcelable support](https://github.com/wuseal/JsonToKotlinClass/issues/194)
* [Customize parent class declaration](https://github.com/wuseal/JsonToKotlinClass/issues/44)
* Generating kotlin data class property order by alphabetical
* [Support customizing this plugin by `Extensions` module](https://github.com/wuseal/JsonToKotlinClass/blob/master/doc/doc_for_extensions.md)
### Generate Example
This is the example JSON from json.org
```json
{
"glossary":{
"title":"example glossary",
"GlossDiv":{
"title":"S",
"GlossList":{
"GlossEntry":{
"ID":"SGML",
"SortAs":"SGML",
"GlossTerm":"Standard Generalized Markup Language",
"Acronym":"SGML",
"Abbrev":"ISO 8879:1986",
"GlossDef":{
"para":"A meta-markup language, used to create markup languages such as DocBook.",
"GlossSeeAlso":[
"GML",
"XML"
]
},
"GlossSee":"markup"
}
}
}
}
}
```
And with this plugin converting, Kotlin data classes would generate like this by default
```kotlin
data class Example(
val glossary: Glossary
)
data class Glossary(
val GlossDiv: GlossDiv,
val title: String
)
data class GlossDiv(
val GlossList: GlossList,
val title: String
)
data class GlossList(
val GlossEntry: GlossEntry
)
data class GlossEntry(
val Abbrev: String,
val Acronym: String,
val GlossDef: GlossDef,
val GlossSee: String,
val GlossTerm: String,
val ID: String,
val SortAs: String
)
data class GlossDef(
val GlossSeeAlso: List,
val para: String
)
```
### Change Log
* [Change log since 3.0.0](doc/CHANGELOG.md)
* [Change log 1.x.x](doc/CHANGELOG_1.X.md)
### Build From Source
Want to try out the newest features?
```shell
$ git clone https://github.com/wuseal/JsonToKotlinClass
$ cd JsonToKotlinClass
$ ./gradlew buildPlugin
```
And you're done! Go to directory `build/distributions` and you'll find `JsonToKotlinClass-x.x.zip`, which can be installed via **Install plugin from disk...**.
### Contribute to This Repo
Find it useful and want to contribute? All sorts of contributions are welcome, including but not limited to:
- Open an issue [here](https://github.com/wuseal/JsonToKotlinClass/issues) if you find a bug;
- Help test the EAP version and report bugs:
Go to the "Plugins" settings, click "Browse repositories..." => "Manage repositories..." and click the "+" button to add the EAP channel repository URL "https://plugins.jetbrains.com/plugins/eap/list". Optionally, you can also add the Alpha and Beta channel repository URLs "https://plugins.jetbrains.com/plugins/alpha/list" and "https://plugins.jetbrains.com/plugins/beta/list".
> Kindly note that the "EAP" or "Alpha" or "Beta" channel update may be unstable and tend to be buggy, if you want to get back to the stable version, remove the "EAP" or "Alpha" or "Beta" version and reinstall this plugin from the "JetBrains Plugin Repository" channel, which can be filtered by the drop-down menu next to the search input field.
- Contribute your code:
```shell
$ git clone https://github.com/wuseal/JsonToKotlinClass
$ cd JsonToKotlinClass
```
Open the `build.gradle` in IntelliJ, open "Gradle" tool window, expand the project view to "JsonToKotlinClass | Tasks | intellij | runIde", right-click and choose "Debug ...", and you're done! Create your PR [here](https://github.com/wuseal/JsonToKotlinClass/pulls)!
### Chinese Detail Document (ä¸æ–‡æ–‡æ¡£)
* http://blog.csdn.net/wuseal/article/details/77508585
### Others
* Any kind of issues are welcome.
* Pull Requests are highly appreciated.
### Thanks
* Thank [@davidbilik](https://github.com/davidbilik) for giving me the first awesome advice.
* Thank [@cgoodroe](https://github.com/cgoodroe) for opening many awesome issues for me, help me improve myself
* Thank [@wangzhenguang](https://github.com/wangzhenguang) for reminding me of the details of the problem
* Thank [@kezhenxu94](https://github.com/kezhenxu94/) for introducing CI/CD to save me a lot of time :)
* Thank [iqbalhood](https://github.com/iqbalhood) for contributing logo for this project
* Thank [akindone](https://github.com/akindone) for adding `order by alphabetical` feature for `JsonToKotlinClass`
* Thank [rafalbednarczuk](https://github.com/rafalbednarczuk) for adding `make keyword property valid` feature for `JsonToKotlinClass`
### Find it useful ? :heart:
* Support and encourage me by clicking the :star: button on the upper right of this page. :v:
* Share to others to help more people have a better develope expierience :heart:
### Authors
This project exists thanks to all the people who contribute.
### Acknowledgement
The development of this plugin is powerly driven by JetBrains.
### Join the Community
| Let's talk |
| -------- |
| [Join JsonToKotlinClass Slack](https://join.slack.com/t/jsontokotlinclass/shared_invite/enQtNjk2NjM1MDM3MDA5LWYxYTI3ZDRlZTMyNDI2Mjg5NzZmZjQzM2ZlNjE5OTFmNWYyY2E0ZGEzZTQ3OWNhODEwOTUwYmU0YmRjZjQ5OGQ)|
| [Join JsonToKotlinClass Telegram](https://t.me/JsonToKotlin) |
### Note：
We analytics anonymous user behavior for improving plugin production, we've provided a switch case for that.