JsonToKotlinClass

GitHub Workflow Status GitHub release GitHub stars JetBrains Plugin Download GitHub closed issues license

Kotlin IntelliJ Idea Plugin Android Studio Plugin

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. With this you can generate Kotlin data class from JSON string programmatically.

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! image

Easy Use

alt text

Want to generate classes code in inner class model? Do like this.

alt text

Want to generate Kotlin data class file? Do like this.

alt text

Want to generate Kotlin data classes in single file? Do like this.

alt text

Usage

File –> Settings –> Plugins –> Browse Repositories –> Search JsonToKotlinClass

Advanced usage

Have a try with the advanced dialog :stuck_out_tongue_winking_eye:

Features

Generate Example

This is the example JSON from json.org

{
    "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

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<String>,
    val para: String
)

Change Log

Want to try out the newest features?

$ 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:

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.

$ 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!

Chinese Detail Document (中文文档)

Others

Thanks

Find it useful ? :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| | Join JsonToKotlinClass Telegram |

Note：

We analytics anonymous user behavior for improving plugin production, we’ve provided a switch case for that.