Skip to content

Getting Started

Introduction

The DGS framework makes it easy to create GraphQL services with Spring Boot. The framework provides an easy-to-use annotation based programming model, and all the advanced features needed to build and run GraphQL services at scale.

The DGS framework is primarily maintained by Netflix, surrounded by an active community. At Netflix we build our GraphQL architecture on the DGS framework.

Create a new Spring Boot application

The DGS framework is now based on Spring Boot 3.0, so get started by creating a new Spring Boot 3.0 application if you don't have one already. Note that you can still use the DGS framework with Spring Boot 2.7 by using a 5.5.x release. The 6.x release of the framework requires Spring Boot 3. The Spring Initializr is an easy way to do so. You can use either Gradle or Maven with Java 17 or Kotlin. We do recommend Gradle because we have a really cool code generation plugin for it!

The only Spring dependency needed is Spring Web.

Spring initializr

Open the project in an IDE (Intellij recommended).

Requirements

The latest 6.x release and onwards will require Spring Boot 3.0 for your project. You will also need JDK 17.

DGS Framework with Spring GraphQL

The DGS Framework has been updated to deeply integrate with Spring GraphQL. For more details on the motivation and implementation, please refer to the docs here For the time being, we will offer 2 flavors of the DGS Framework - one with the vanilla version, and a version that integrates with spring-graphql via different starters. There are no breaking changes to users as the changes are mostly internal to the framework and the spring-graphql integration should be a drop-in replacement for the existing framework. For this reason, we encourage new and existing DGSs to use our spring-graphql starter as much as possible, as this will be the default offering in the future. You can read more about the motivation behind integrating with spring-graphql and the details of the integration here.

Adding the DGS Framework dependency with Spring GraphQL

  1. Add the platform BOM to your Gradle or Maven configuration. The com.netflix.graphql.dgs:graphql-dgs-platform-dependencies dependency is a platform/BOM dependency, which aligns the versions of the individual modules and transitive dependencies of the framework.

  2. Add the DGS starter. The com.netflix.graphql.dgs:graphql-dgs-spring-graphql-starter is a Spring Boot starter that includes everything you need to get started building a DGS that uses Spring GraphQL.

  3. Add the relevant Spring Boot starter for the web flavor you want to use. This would one of org.springframework.boot:spring-boot-starter-web or org.springframework.boot:spring-boot-starter-webflux depending on the stack you are using.

If you want to use the regular flavor of the DGS framework without the spring-graphql starter, refer to the next section on Adding the DGS Framework Dependency

repositories {
    mavenCentral()
}

dependencyManagement {
  imports {
     mavenBom("com.netflix.graphql.dgs:graphql-dgs-platform-dependencies:latest.release")
  }
}

dependencies {
  implementation "com.netflix.graphql.dgs:graphql-dgs-spring-graphql-starter"
}

repositories {
    mavenCentral()
}

dependencyManagement {
  imports {
     mavenBom("com.netflix.graphql.dgs:graphql-dgs-platform-dependencies:latest.release")
  }
}

dependencies {
  implementation("com.netflix.graphql.dgs:graphql-dgs-spring-graphql-starter")
}

<dependencyManagement>
   <dependencies>
      <dependency>
         <groupId>com.netflix.graphql.dgs</groupId>
         <artifactId>graphql-dgs-platform-dependencies</artifactId>
         <!-- The DGS BOM/platform dependency. This is the only place you set version of DGS -->

         <version>[LATEST_VERSION]
         </version> <!-- Replace [LATEST_VERSION] with the [latest available version](https://mvnrepository.com/artifact/com.netflix.graphql.dgs/graphql-dgs-platform-dependencies) -->
         <type>pom</type>
         <scope>import</scope>
      </dependency>
   </dependencies>
</dependencyManagement>

<dependencies>
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
   <groupId>com.netflix.graphql.dgs</groupId>
   <artifactId>graphql-dgs-spring-graphql-starter</artifactId>
</dependency>

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-test</artifactId>
   <scope>test</scope>
</dependency>
</dependencies>

Creating a Schema

The DGS framework is designed for schema first development. The framework picks up any schema files in the src/main/resources/schema folder. Create a schema file in: src/main/resources/schema/schema.graphqls.

type Query {
    shows(titleFilter: String): [Show]
}

type Show {
    title: String
    releaseYear: Int
}

This schema allows querying for a list of shows, optionally filtering by title.

Implement a Data Fetcher

Data fetchers are responsible for returning data for a query.

With the new Spring-GraphQL integration, it is technically possible to mix and match the DGS/Spring-GraphQL programming models. However, to maintain consistency in your codebase and to take full advantage of DGS features, we recommend sticking with the DGS programming model. Not all DGS features are applicable to Spring-GraphQL data fetchers in the current integration and would therefore not work as expected. Refer to our Known Gaps and Limitations section for more details.

Create two new classes example.ShowsDataFetcher and Show and add the following code.

Note that we have a Codegen plugin that can do this automatically, but in this guide we'll manually write the classes.

import java.util.List;
import java.util.stream.Collectors;

import com.netflix.graphql.dgs.DgsComponent;
import com.netflix.graphql.dgs.DgsQuery;
import com.netflix.graphql.dgs.InputArgument;

@DgsComponent
public class ShowsDataFetcher {

  private final List<Show> shows = List.of(
          new Show("Stranger Things", 2016),
          new Show("Ozark", 2017),
          new Show("The Crown", 2016),
          new Show("Dead to Me", 2019),
          new Show("Orange is the New Black", 2013)
  );

  @DgsQuery
  public List<Show> shows(@InputArgument String titleFilter) {
      if(titleFilter == null) {
          return shows;
      }

      return shows.stream().filter(s -> s.title().contains(titleFilter)).collect(Collectors.toList());
  }
}

record Show(String title, int releaseYear) {}

import java.util.List;
import java.util.stream.Collectors;

import com.netflix.graphql.dgs.DgsComponent;
import com.netflix.graphql.dgs.DgsQuery;
import com.netflix.graphql.dgs.InputArgument;

@DgsComponent
class ShowsDataFetcher {
  private val shows = listOf(
      Show("Stranger Things", 2016),
      Show("Ozark", 2017),
      Show("The Crown", 2016),
      Show("Dead to Me", 2019),
      Show("Orange is the New Black", 2013))

  @DgsQuery
  fun shows(@InputArgument titleFilter : String?): List<Show> {
      return if(titleFilter != null) {
          shows.filter { it.title.contains(titleFilter) }
      } else {
          shows
      }
  }

  data class Show(val title: String, val releaseYear: Int)
}

That's all the code needed, the application is ready to be tested!

Test the app with GraphiQL

Start the application and open a browser to http://localhost:8080/graphiql. GraphiQL is a query editor that comes out of the box with the DGS framework. Write the following query and tests the result.

gradle bootRun

mvn spring-boot:run

{
    shows {
        title
        releaseYear
    }
}

Note that unlike with REST, you have to specifically list which fields you want to get returned from your query. This is where a lot of the power from GraphQL comes from, but a surprise to many developers new to GraphQL.

The GraphiQL editor is really just a UI that uses the /graphql endpoint of your service. You could now connect a UI to your backend as well, for example using React and the Apollo Client.

Install the Intellij plugin

If you are an Intellij user, there is a plugin available for DGS. The plugin supports navigation between schema files and code and many hints and quick fixes. You can install the plugin from the Jetbrains plugin repository here.

Plugin installation

Next steps

Now that you have a first GraphQL service running, we recommend improving this further by doing the following: