jsonschema2pojo

You can install the jsonschema2pojo command line utility using Homebrew.

brew install jsonschema2pojo

To run or explore the Android example project, open the project directory directly with Android Studio.

Note: The included Gradle wrapper (gradlew) requires JDK 17 or higher to function.

To test local modifications of the jsonschema2pojo-gradle-plugin in an existing Gradle project, follow these steps:

1. Build and install the plugin to your local Maven repository from the project root using ./mvnw clean install.
2. Configure your target project's build.gradle to use mavenLocal() in both the buildscript and the project repositories blocks.
3. Update the plugin dependency to use the latest.integration version.

buildscript {
    repositories {
        mavenLocal()
    }
    dependencies {
        classpath 'org.jsonschema2pojo:jsonschema2pojo-gradle-plugin:latest.integration'
    }
}

repositories {
    mavenLocal()
}

For Gradle 7.3 and later, use the plugins DSL to apply the plugin. For Gradle 7.2.x and older, you must use the legacy plugin application method due to a known plugin application order bug.

// For Gradle 7.3+
plugins {
  id "java"
  id "org.jsonschema2pojo" version "1.3.3"
}

The generateJsonSchema2Pojo task is automatically triggered in projects containing a jsonSchema2Pojo configuration closure. When executed, it performs the following actions:

1. Invokes the jsonschema2pojo generator.
2. Makes the compileJava task dependent on this task.
3. Adds the targetDirectory to the main/java source set so the Java compiler can locate and compile the generated source files.

The jsonschema2pojo command line interface allows you to generate Java classes from JSON Schemas. Arguments are expected in POSIX format. To view all available options and details, invoke the command with the --help flag.

If the application encounters paths that do not exist, it will throw a FileNotFoundException. If it cannot read data from the specified paths, it will throw an IOException.

To use jsonschema2pojo in a Gradle project, apply the org.jsonschema2pojo plugin and configure the jsonSchema2Pojo extension block. You can set the targetPackage within this block.

plugins {
  id "java"
  id "org.jsonschema2pojo" version "1.3.3"
}

repositories {
  mavenCentral()
}

jsonSchema2Pojo {
  targetPackage = 'com.example'
}

To use jsonschema2pojo in a Maven project, add the jsonschema2pojo-maven-plugin to your pom.xml. You can configure the sourceDirectory where your schemas are located and the targetPackage for the generated classes.

<plugin>
    <groupId>org.jsonschema2pojo</groupId>
    <artifactId>jsonschema2pojo-maven-plugin</artifactId>
    <version>1.3.3</version>
    <configuration>
        <sourceDirectory>${basedir}/src/main/resources/schema</sourceDirectory>
        <targetPackage>com.example.types</targetPackage>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
</plugin>