Spring Doc swagger API 上的日期格式时间

Question

我正在尝试使用 spring doc 从我的 springboot 应用程序生成文档，这是导致我出现问题的类的一些属性：

public class user {

    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date dateOfBirth;

}

使用 Spring 文档注释，我大摇大摆地得到了这个：

dateOfBirth* 字符串($date-time)

"dateOfBirth": "2020-04-29T14:15:32.475Z"

虽然我想要这个：

dateOfBirth* 字符串($date)

"dateOfBirth": "2020-04-29"

如何做到这一点？我认为接近解决方案，但我无法弄清楚我所缺少的

Answer 1

我想你正在寻找的答案在这里：swagger date field vs date-time field

Date 是一个对象DateTime 用于招摇，因为它实际上是一个 DateTime 对象。使用适当的类型，例如LocalDate，他们知道如何处理。

顺便说一句，您希望 Swagger 如何正确地将日期模式转换为适当的类型？这就像太多的魔法。 Swagger 依赖于常见的做法。

JSONFormat 不会改变 swagger 解释数据的方式。