This version is still in development and is not considered stable yet. For the latest stable version, please use Spring GraphQL 1.3.3!

Code Generation

You can use tools such as DGS Codegen to generate Java types from the GraphQL schema. The following can be generated:

  1. Client types for requests (e.g. query, mutation) input types, and response selection types.

  2. Data types corresponding to GraphQL schema types.

Code generation may not be ideal for your own application’s data types especially if you want to add logic to them. Code generation, however, is a good fit for client types since those define the request, and don’t need to have other logic. As a client, you may also choose to generate the data types for the response.

Client generated types can be used with Spring’s DgsGraphQlClient. Start by following the instructions for the DGS code generation plugin to generate client API types. Then, given a schema like this:

Spring Initializer at start.spring.io can create a Spring project with the DGS Codegen Gradle or Maven plugin.