GraphQL ISO Date is a set of RFC 3339 compliant date/time scalar types to be used with graphql-java.

A set of ISO 33601, RFC 3339 compatible date time scalars for GraphQL Java implementation (graphql-java), as well as starters for

• GraphQL Java Kickstart graphql-java-kickstart
• Netflix DGS Framework dgs-framework
• Spring GraphQL spring-graphql

java.util.Date, java.time.LocalDate, java.time.LocalDateTime

java.time.LocalTime

java.time.Duration

This library supports the following popular graphql-java framework:

• GraphQL Java Kickstart graphql-java-kickstart
• Netflix DGS Framework dgs-framework
• Spring GraphQL spring-graphql

Add one of the following starters according to your project.

Add the following to your pom.xml:

for GraphQL Java Kickstart:

<dependency> <groupId>com.tailrocks.graphql</groupId> <artifactId>graphql-datetime-kickstart-spring-boot-starter</artifactId> <version>6.0.0</version> </dependency>

for Netflix DGS:

<dependency> <groupId>com.tailrocks.graphql</groupId> <artifactId>graphql-datetime-dgs-starter</artifactId> <version>6.0.0</version> </dependency>

for Spring GraphQL:

<dependency> <groupId>com.tailrocks.graphql</groupId> <artifactId>graphql-datetime-spring-boot-starter</artifactId> <version>6.0.0</version> </dependency>

Add the following to your build.gradle:

for GraphQL Java Kickstart (Spring Boot):

implementation("com.tailrocks.graphql:graphql-datetime-kickstart-spring-boot-starter:6.0.0")

for DGS:

implementation("com.tailrocks.graphql:graphql-datetime-dgs-starter:6.0.0")

for Spring GraphQL:

implementation("com.tailrocks.graphql:graphql-datetime-spring-boot-starter:6.0.0")

Add these scalars to your .graphqls schema file:

# java.util.Date implementationscalarDate# java.time.LocalDate implementationscalarLocalDate# java.time.LocalDateTime implementationscalarLocalDateTime# java.time.LocalTime implementationscalarLocalTime# java.time.OffsetDateTime implementationscalarOffsetDateTime# java.time.YearMonth implementationscalarYearMonth# java.time.Duration implementationscalarDuration

You can rename the scalar however you want by simply adding the following properties to your application.yaml:

graphql: datetime: scalars: date: scalar-name: MyDatelocal-date: scalar-name: MyLocalDatelocal-date-time: scalar-name: MyLocalDateTimelocal-time: scalar-name: MyLocalTimeoffset-date-time: scalar-name: MyOffsetDateTimeyear-month: scalar-name: MyYearMonthduration: scalar-name: MyDuration

A custom format can be set for LocalDate and LocalDateTime only using the following properties in application.yaml

graphql: datetime: scalars: local-date: format: MM/dd/yyyylocal-date-time: format: yyyy-MM-dd'T'HH:mm:ss

You can enable automatic zone conversion by adding the following property to your application.yaml. This will automatically convert between UTC and the default TimeZone for LocalDateTime:

graphql: datetime: scalars: zone-conversion-enabled: true

If using OffsetDateTime in order to present the offset and disable the automatic convertion to UTC from Jackson you should set to your application.yml the following:

spring: jackson: deserialization: adjust-dates-to-context-time-zone: false

Now you can use these scalars in your application. Here are graphql-datetime spring boot sample applications:

• webmvc:
  • dgs: sample-graphql-datetime-dgs-webmvc
  • kickstart: sample-graphql-datetime-kickstart-webmvc
  • spring-graphql: sample-graphql-datetime-spring-boot-webmvc
• webflux:
  • kickstart: sample-graphql-datetime-kickstart-webflux

To report any bug, please use the project Issues section on GitHub.

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

Copyright © 2017-2023 Alexey Zhokhov. All rights reserved.

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.