2

在我的 spring-boot 应用程序中,我使用 swagger2 来记录 Web 服务。

我使用一些具有 java.sql.Time 和 java.util.Date 属性的类。

在 swagger-ui 中,它们看起来像这样:

日期 :在此处输入图像描述

时间 :在此处输入图像描述

我想修改它以显示:

  • “change_date”:“YYYY-MM-DD”

  • “change_time”:“mm:ss”

这是我的课:

@lombok.Data
@JsonRootName("translation_value")
@ApiModel(value="TranslationValue", description="Traduction de valeur")
public class TranslationValue implements Serializable {

@JsonProperty("translation_id") private Integer translationId;
@JsonProperty("family") private String family;
@JsonProperty("language_code") private String languageCode;
@JsonProperty("value") private String value;
@JsonProperty("translation_language_code") private String translationLanguageCode;
@JsonProperty("translation_value") private String translationValue;
@JsonProperty("delivered") private String delivered;
@JsonProperty("creation_date") private Date creationDate;
@JsonProperty("creation_time") private Time creationTime;
@JsonProperty("creation_user") private String creationUser;
@JsonProperty("change_date") private Date changeDate;
@JsonProperty("change_time") private Time changeTime;
@JsonProperty("change_user") private String changeUser;
@JsonProperty("status") private String status;
@JsonProperty("orignal_translation_id") private Integer orignalTranslationId;
}

我怎样才能做到这一点 ?我没有找到任何注释来设置格式。

4

3 回答 3

3

我们有类似的问题。我们需要将 springfox 版本升级到 2.3.0 ,之前我们使用的是 springfox 2.2.2 版本。在那个旧版本中,swagger 的 @ApiModelPreporty 有一个名为“example”的属性,它没有做任何事情。从 2.3.0 版本开始,这个“示例”开始工作。所以在我们将 springfox 版本升级到 2.3.0 之后,我们所要做的就是如下所示。

@ApiModelProperty(required = true,example = "2016-01-01")
@JsonFormat(pattern = DATE_FORMAT)
private LocalDate date; 

以下是我们找到此信息的链接:

https://github.com/springfox/springfox/issues/998

于 2016-02-02T21:54:36.510 回答
0

我希望这仍然有帮助。

我正在使用 swagger jersey 2。

我认为 Swagger 目前没有使用 JsonProperty 注释。您仍然可以使用 Swagger Annotation 指示您需要的属性名称:

@ApiModelProperty(name = "index-url")

这是双重工作,但它是我能找到的唯一解决方案。

问候

于 2016-01-13T03:42:14.497 回答
0
@ApiModelProperty(value = "description", name = "notificationExpiryDate",
            dataType = "String", example = "2022-01-16T08:42:37.484Z")
private Timestamp expiryDate;

将 dataType 作为 String 让我得到了这个例子。

于 2022-01-19T17:54:14.270 回答