Swagger UI 显示 LocalDateTime（单位为毫秒），尽管有格式规范

Question

我在 Spring Boot 应用程序中遇到了 Swagger UI 的问题，其中日期时间值以毫秒显示

(2024-05-13T11:20:24.151Z)

，尽管指定了不带毫秒的日期时间格式

(yyyy-MM-dd'T'HH:mm:ss)

。这种差异正在影响 Swagger 文档中显示的示例值以及“尝试一下”功能的行为。

这是我的注释设置：

@DateTimeFormat(pattern = )
@JsonFormat(pattern = "yyyy-MM-dd'T'HH:mm:ss")
@Schema(example = "2022-10-30T12:45:00", description = "Date time with UTC format")
private LocalDateTime dateTime;

Answer 1

@Schema(example = "2022-10-30T12:45:00", type = "string", description = "Date time")
private LocalDateTime dateTime;

通过显式设置 type = "string"，您可以指示 Swagger 在文档生成过程中将 dateTime 字段视为字符串，这可以解决日期时间格式的差异并在 Swagger UI 中显示。