Skip to content

README.md

Latest commit

 

History

History
33 lines (22 loc) · 1.67 KB

README.md

File metadata and controls

33 lines (22 loc) · 1.67 KB
Raw

CI GitHub release Apache 2.0

DGS Code Generation Plugin

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

Getting Started

To get started with the DGS Framework the getting started guide is great starting place. Documentation for DGS Code Generation can be found here.

Generated documentation

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.

Contributing, asking questions and reporting issues.

Please read our contributor guide!