如何使Swagger 3 UI以DDMMYYYY格式显示示例日期？

Question

我有一个带有REST API的Spring Boot应用程序，在一个请求对象中，我声明了一个字段，该字段应该以DDMMYYYY格式保存日期：

@Parameter(required = true, example = "20022022")
@Schema(required = true, type = "date", format = "ddmmyyyy", example = "20022022")
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "ddMMyyyy")a
@JsonDeserialize(using = LocalDateDeserializer.class)
@NotNull
private LocalDate valueDate;

在Swagger UI中，请求正文中该字段的示例值始终显示如下（当前日期的格式为YYYY-MM-DD）。

{
    ...
    "valueDate": "2022-03-17"
}

我在pom.xml中有这样的内容：

    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-webmvc-core</artifactId>
        <version>1.6.4</version>
    </dependency>
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
        <version>1.6.6</version>
    </dependency>

如何使Swagger UI以DDMMYYYY格式显示示例日期？正如你在我上面的代码中看到的，我输入了@Parameter和@Schema，但我真的不知道它们是如何工作的。

Answer 1

您可以使用ApiModelProperty指定swagger默认/示例值。

@ApiModelProperty(value = "dd/MM/yyyy", example = "20/02/2022")
private LocalDate creationDate;

或

@ApiModelProperty(value = "ddMMyyyy", example = "20022022")
protected LocalDate creationDate;