The DGS Code Generation plugin generates code during your project’s build process based on your GraphQL schema file. The plugin generates the following:
- Data types for types, input types, enums and interfaces.
- A DgsConstants class containing the names of types and fields
- A type safe query API that represents your queries
- Example data fetchers
To get started with the DGS Framework the getting started guide is great starting place. Documentation for DGS Code Generation can be found here.
The Gradle plugin can generate Markdown documentation by setting generateDocs = true in the generateJava task
configuration. It writes the files to <generatedSourcesDir>/generated/docs/dgs-codegen; with the default
generatedSourcesDir of build, that is build/generated/docs/dgs-codegen. Changing generatedSourcesDir moves the
documentation along with generated source output. When documentation generation is disabled, this directory is not
created.
Please read our contributor guide!