如何在 Swagger 2.x 中使用 java.time.Instant？

问题描述

我的 java webapp 中有一个 REST 端点，它接受 Instant 作为查询参数，如下面的代码所示

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

这在 swagger 1.x 下运行良好，但是当我们切换到 swagger 2.x 时，Instant 的对象显示为 $int64 而不是日期时间字段。我可以用 swagger 注释做些什么来让它工作？

解决方法

我能够使用@ApiParam 注释来解决这个问题。将类型设置为 date-time 并将格式设置为 java.time.Instant 解决了该问题。

@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) {
    ...
}