This maven plugin is a port of the netflix codegen plugin for Gradle. Found here.
Feel free to simply create a GitHub issue for requests to integrate with newer releases of the core DGS Codegen library.
PRS are welcome as well. The level of difficulty across DGS Codgen updates varies. Typically we add new plugin options and update the CodeGenConfig constructor - when new options are added to the Codegen core library.
Please make sure you run step 2 below to ensure your PR builds correctly. You may need to analyze the CodeGenConfig ctor parameters and add support for new options.
Make sure to document any new options to the Options section below.
Process:
- bump the version in pom.xml
- run
mvn installlocally to ensure the project still builds - Adjust CodeGen to support new options if needed.
The DGS Code Generation plugin generates code for basic types and example data fetchers based on your Domain Graph
Service's graphql schema file during the project's build process. The plugin requires the designated packageName for file generation.
If no schemaPath is specified, it will look in the src/main/resources/schema folder for
any files with .graphqls extension.
https://github.com/deweyjose/graphqlcodegen-example
Options are configured in the <configuration> element of the dgs-codegen-maven-plugin plugin.
This options enables the plugin to limit code generation to only schema files that have changed. Today this only works with schemaPaths.
This only works for <schemaPaths>. A subsequent release for schema compilation via dependencies will be release soon.
- Type: boolean
- Required: false
- Default: true
<onlyGenerateChanged>true</onlyGenerateChanged>- Type: string
- Required: false
- Default: docs
Example
<subPackageNameDocs>docs</subPackageNameDocs>- Type: string
- Required: false
- Default: docs
Example
<generateDocs>true</generateDocs>- Type: string
- Required: false
- Default: ./generated-docs
Example
<generatedDocsFolder>true</generatedDocsFolder>- Type: boolean
- Required: false
- Default: false
Example
<addGeneratedAnnotation>true</addGeneratedAnnotation>- Type: boolean
- Required: false
- Default: false
Example
<dgs.codegen.skip>true</dgs.codegen.skip>Or
# mvn ... -Ddgs.codegen.skip=true- Type: array
- Required: false
- Default:
${project.build.resources}/schema
Example
<schemaPaths>
<param>src/main/resources/schema/schema.graphqls1</param>
<param>src/main/resources/schema/schema.graphqls2</param>
</schemaPaths>- Type: array
- Required: false
- Default: []
- Official doc : https://netflix.github.io/dgs/generating-code-from-schema/#generating-code-from-external-schemas-in-jars.
- Please note that
.graphql(s)files must exist under theMETA-INFfolder in the external jar file.
Example
<schemaJarFilesFromDependencies>
<param>com.netflix.graphql.dgs:some-dependency:1.0.0</param>
<param>com.netflix.graphql.dgs:some-dependency:X.X.X</param>
</schemaJarFilesFromDependencies>- Type: string
- Required: true
Example
<packageName>com.acme.se.generated</packageName>- Type: map
- Required: false
Example
<typeMapping>
<Date>java.time.LocalDateTime</Date>
</typeMapping>Provide typeMapping as properties file(s) that is accessible as a compile-time-classpath resource
Key-Value pairs in the properties file will be added to typeMapping Map when it is not already present in it
When a same GraphQL type is present in both typeMapping and also in typeMappingPropertiesFiles, value in typeMapping will be used (and the value from typeMappingPropertiesFiles will be ignored)
- Type: Array
- Required: false
Example
<typeMappingPropertiesFiles>
<typeMappingPropertiesFile>commontypes-typeMapping.properties</typeMappingPropertiesFile>
<typeMappingPropertiesFile>someother-commontypes-typeMapping.properties</typeMappingPropertiesFile>
</typeMappingPropertiesFiles>- Type: string
- Required: false
- Default: client
Example
<subPackageNameClient>client</subPackageNameClient>- Type: string
- Required: false
- Default: client
Example
<subPackageNameDatafetchers>datafetchers</subPackageNameDatafetchers>- Type: string
- Required: false
- Default: client
Example
<subPackageNameTypes>types</subPackageNameTypes>- Type: boolean
- Required: false
- Default: false
Example
<generateBoxedTypes>false</generateBoxedTypes>- Type: boolean
- Required: false
- Default: false
Example
<generateClientApi>false</generateClientApi>- Type: boolean
- Required: false
- Default: false
Example
<generateClientApiV2>false</generateClientApiV2>- Type: boolean
- Required: false
- Default: false
Example
<generateInterfaces>false</generateInterfaces>- Type: boolean
- Required: false
- Default: false
Example
<generateKotlinNullableClasses>false</generateKotlinNullableClasses>- Type: boolean
- Required: false
- Default: false
Example
<generateKotlinClosureProjections>false</generateKotlinClosureProjections>- Type: string
- Required: false
- Default:
${project.basedir}/target/generated-sources
Example:
<outputDir>${project.build.directory}/generated-sources</outputDir>- Type: string
- Required: false
- Default:
${project.basedir}/target/generated-examples
Example:
<outputDir>${project.build.directory}/generated-examples</outputDir>- Description: Limit generation to specified set of queries. Used in conjunction with
generateClient. - Type: array
- Required: false
- Default: []
Example
<includeQueries>
<param>QueryFieldName1</param>
<param>QueryFieldName2</param>
</includeQueries>- Description: Limit generation to specified set of mutations. Used in conjunction with
generateClient. - Type: array
- Required: false
- Default: []
Example
<includeMutations>
<param>MutationFieldName1</param>
<param>MutationFieldName1</param>
</includeMutations>- Type: boolean
- Required: false
- Default: false
Example
<skipEntityQueries>false</skipEntityQueries>- Type: boolean
- Required: false
- Default: false
Example
<shortProjectionNames>false</shortProjectionNames>- Type: boolean
- Required: false
- Default: false
Example
<generateDataTypes>false</generateDataTypes>- Type: int
- Required: false
- Default: 10
Example
<maxProjectionDepth>10</maxProjectionDepth>- Type: String
- Required: false
- Default: java
Example
<language>kotlin</language>- Type: boolean
- Required: false
- Default: false
Example
<omitNullInputFields>false</omitNullInputFields>- Type: boolean
- Required: false
- Default: false
Example
<kotlinAllFieldsOptional>false</kotlinAllFieldsOptional>- Type: boolean
- Required: false
- Default: false
Example
<snakeCaseConstantNames>false</snakeCaseConstantNames>- Type: boolean
- Required: false
- Default: true
Example
<writeToFiles>false</writeToFiles>- Type: array
- Required: false
- Default: []
Example
<includeSubscriptions>
<param>Subscriptions1</param>
<param>Subscriptions2</param>
</includeSubscriptions>- Type: boolean
- Required: false
- Default: true
Example
<generateInterfaceSetters>false</generateInterfaceSetters>- Type: boolean
- Required: false
- Default: false
Example
<generateInterfaceMethodsForInterfaceFields>false</generateInterfaceMethodsForInterfaceFields>- Type: boolean
- Required: false
- Default: false
Example
<javaGenerateAllConstructor>false</javaGenerateAllConstructor>- Type: boolean
- Required: false
- Default: false
Example
<implementSerializable>false</implementSerializable>- Type: boolean
- Required: false
- Default: false
<generateCustomAnnotations>false</generateCustomAnnotations>- Type: boolean
- Required: false
- Default: false
<addDeprecatedAnnotation>false</addDeprecatedAnnotation>- Type: map<string, string>
- Required: false
<includeImports>
<validator>com.test.validator</validator>
</includeImports>- Type: map<string,<string,string>>
- Required: false
<includeEnumImports>
<foo>
<properties>
<bar>bla</bar>
</properties>
</foo>
<bar>
<properties>
<zoo>bar.bar</zoo>
<zing>bla.bla</zing>
</properties>
</bar>
</includeEnumImports>Maps the custom annotation and class names to the class packages. Only used when generateCustomAnnotations is enabled.
- Type
- Required: false
<includeClassImports>
<foo>
<properties>
<bar>bla</bar>
</properties>
</foo>
<bar>
<properties>
<zoo>bar.bar</zoo>
<zing>bla.bla</zing>
</properties>
</bar>
</includeClassImports>- Type: boolean
- Required: false
- Default: false
Example
<generateIsGetterForPrimitiveBooleanFields>false</generateIsGetterForPrimitiveBooleanFields>Add the following to your pom files build/plugins section.
<plugin>
<groupId>io.github.deweyjose</groupId>
<artifactId>graphqlcodegen-maven-plugin</artifactId>
<version>1.24</version>
<executions>
<execution>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<configuration>
<schemaPaths>
<param>src/main/resources/schema/schema.graphqls</param>
</schemaPaths>
<packageName>com.acme.[your_project].generated</packageName>
<addGeneratedAnnotation>true</addGeneratedAnnotation>
</configuration>
</plugin>You'll also need to add the generates-sources folder to the classpath:
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>add-source</goal>
</goals>
<configuration>
<sources>
<source>${project.build.directory}/generated-sources</source>
</sources>
</configuration>
</execution>
</executions>
</plugin>COPIED FROM NETFLIX DOCUMENTATION.
The generated types are available as part of the packageName.types package under build/generated. These are automatically added to your project's sources. The generated example data fetchers are available under build/generated-examples. Note that these are NOT added to your project's sources and serve mainly as a basic boilerplate code requiring further customization.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent