Getting started

A working Java Spring-Boot application is provided, based off the Star Wars API tests and test data. If you’re using Spring Boot, check out the graphql-spring-boot-starter!

A working Kotlin example can be found in the tests.

Quick start

To add graphql-java-tools to your project and get started quickly, do the following.

Version 15 needs Java 17, graphql-java 26 and Jackson 3. graphql-spring-boot-starter is archived and doesn’t work with it, so stay on 14.5.0 with the starter.

Build with Gradle

Make sure mavenCentral is amongst your repositories:

repositories {
    mavenCentral()
}

Add the graphql-java-tools dependency:

dependencies {
    implementation 'io.github.graphql-java-kickstart:graphql-java-tools:15.0.0'
}

Build with Maven

Add the graphql-java-tools dependency:

<dependency>
  <groupId>io.github.graphql-java-kickstart</groupId>
  <artifactId>graphql-java-tools</artifactId>
  <version>15.0.0</version>
</dependency>

The release notes list what changed in each version, including behaviour changes and breaking changes.

Using the latest development build

Snapshot versions of the current master branch are available on the Maven Central snapshot repository. Check the next snapshot version on Github

Build with Gradle

Add the Snapshot repository:

repositories {
    mavenCentral()
    maven { url = 'https://central.sonatype.com/repository/maven-snapshots/' }
}

Build with Maven

Add the Snapshot repository:

<repositories>
  <repository>
    <id>central-portal-snapshots</id>
    <name>Central Portal Snapshots</name>
    <url>https://central.sonatype.com/repository/maven-snapshots/</url>
    <releases>
      <enabled>false</enabled>
    </releases>
    <snapshots>
      <enabled>true</enabled>
      <updatePolicy>always</updatePolicy>
    </snapshots>
  </repository>
</repositories>