Files
spring-graphql/spring-graphql-docs/modules/ROOT/pages/codegen.adoc
Brian Clozel 6ddaeadbd5 Fix codegen documentation section
Closes gh-1188
2025-04-15 22:33:28 +02:00

20 lines
1018 B
Plaintext

[[codegen]]
= Code Generation
You can use tools such as
https://netflix.github.io/dgs/generating-code-from-schema/[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.
Start by following the instructions for the DGS code generation plugin to generate client API types.
Then you can xref:client.adoc#client.dgsgraphqlclient[use client generated types with Spring's DgsGraphQlClient].
TIP: Spring Initializer at https://start.spring.io can create a Spring project with
the DGS Codegen Gradle or Maven plugin.