graphql-kotlin-schema-generator can directly map most Kotlin "primitive" types to standard GraphQL scalar types or
extended scalar types provided by
|Kotlin Type||GraphQL Type|
> NOTE: Extended GraphQL scalar types provided by
graphql-java were deprecated in v15.
> This includes the following types:
> If you are currently using these types, they will be removed in future
> See the graphql-java-extended-scalars project if you need continued support.
GraphQL supports the scalar type
ID, a unique identifier that is not intended to be human readable. IDs are
serialized as a
String. To expose a GraphQL
ID field, you must use the
com.expediagroup.graphql.scalars.ID class, which wraps the underlying
graphql-java supports additional types (
UUID) but due to serialization issues we can only directly support Strings. You can still use a type like UUID internally just as long as you convert or parse the value yourself and handle the errors.
This would produce the following schema:
graphql-kotlin-schema-generator uses Kotlin reflections to generate all schema objects. If you want to
apply custom behavior to the objects, you can also define your own custom scalars. Custom scalars have to be explicitly
added to the schema through
See the Generator Configuration documentation for more information.
Once the scalars are registered you can use them anywhere in the schema as regular objects.
graphql-kotlin only supports the primitive scalar types listed above. If you are looking to use common java types as scalars, you need to include the graphql-java-extended-scalars library and set up the hooks (see above), or write the logic yourself for how to resolve these custom scalars.
The most popular types that require extra configuration are:
If you see the following message
Cannot convert ** since it is not a valid GraphQL type or outside the supported packages ***. This means that you need to update the generator configuration to include the package of your type or you did not properly set up the hooks to register the new type.