How to use java.time.Instant with Swagger 2.x?

Question

I have a REST endpoint in my java webapp that accepts an Instant as a query parameter as seen in the code below

@GET
@Produces(MediaType.APPLICATION_JSON)
Response getHistory(
    @QueryParam("beforeTime")
    Instant beforeTime,

    @QueryParam("afterTime")
    Instant afterTime) {
    ...
}

This worked well under swagger 1.x, but when we switch to swagger 2.x the objects of Instant are showing up as $int64 instead of a date-time field. What can I do with the swagger annotations to get this to work?

Mike · Accepted Answer · 2021-01-07 17:59:55Z

1

I was able to use the @ApiParam annotation to fix this issue. Setting the type to date-time and format to java.time.Instant fixed the issue.

@GET
@Produces(MediaType.APPLICATION_JSON)
Response getHistory(
    @QueryParam("beforeTime")
    @ApiParam(type="date-time", format = "java.time.Instant")
    Instant beforeTime,

    @QueryParam("afterTime")
    @ApiParam(type="date-time", format = "java.time.Instant")
    Instant afterTime) {
    ...
}

answered Jan 7, 2021 at 17:59

Mike

8327 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to use java.time.Instant with Swagger 2.x?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related