Java springdoc-openapi 在 Swagger UI 示例值中显示带有附加日期/时间字段的 LocalDateTime 字段

Question

spring-boot 2.6.2
springdoc-openapi 1.6.2

Single field LocalDateTime dateTime in body represent in Swagger UI Example Value as

{
  "dateTime": "2022-01-21T10:02:46.481Z",
  "time": {
    "hour": 0,
    "minute": 0,
    "second": 0,
    "nano": 0
  },
  "date": "2022-01-21"
}

Date format can be fixed ( https://ru.stackoverflow.com/a/1276885/209226 ) by

    static {
        var schema = new Schema<LocalTime>();
        schema.example(LocalTime.now().format(DateTimeFormatter.ISO_TIME));
        SpringDocUtils.getConfig().replaceWithSchema(LocalTime.class, schema);
    }

But it is still remained 3 fields iso one dateTime :

{
  "dateTime": "2022-01-21T10:05:52.945Z",
  "time": "13:05:14.746",
  "date": "2022-01-21"
}

How can it be fixed?

Answer 1

if you want a better representation you need to add a type, in my case string. See Docs ( https://swagger.io/specification/ )

static {
            var schema = new Schema<LocalTime>();
            schema.example(LocalTime.now().format(DateTimeFormatter.ofPattern("HH:mm:ss"))).type("string");
            SpringDocUtils.getConfig().replaceWithSchema(LocalTime.class, schema);
        }

Answer 2

For Kotlin Developer:

@Configuration
open class SwaggerConfig{
    init {
        val schema: Schema<LocalDateTime> = Schema<LocalDateTime>()
        schema.example(LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")))
        SpringDocUtils.getConfig().replaceWithSchema(LocalDateTime::class.java, schema)
    }
}