java - 在 Java 中隐藏 swagger UI 中不重要的 getter 方法

Question

这个问题已经有答案了:

How to hide a parameter in swagger? (9 个回答)

已关闭 6 个月前。

我的类(class)中有两个字段 startDate和endDate的LocalDateTime 。在内部，这些需要返回为 Optional<ZonedDateTime> ，而在查询中它们以 LocalDateTimes 形式提供。

@ApiModel
public class SearchQuery {

    private static final ZoneId UTC_TIMEZONE = ZoneId.of("UTC");

    @ApiParam(value = "Start date and time of the requested time frame.", example = "2019-06-01T12:30", defaultValue = "0000-01-01T00:00")
    @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
    private LocalDateTime startDate;

    @ApiParam(value = "End date and time of the requested time frame.", example = "2019-06-30T23:59", defaultValue = "9999-12-31T23:59")
    @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
    private LocalDateTime endDate;

    public LocalDateTime getStartDate() {
        return this.startDate;
    }

    public LocalDateTime getEndDate() {
        return this.endDate;
    }

    public Optional<ZonedDateTime> getStartDateWithTimezone() {
        return Optional.ofNullable(startDate)
            .map(date -> date.atZone(UTC_TIMEZONE));
    }

    public Optional<ZonedDateTime> getEndDateWithTimezone() {
        return Optional.ofNullable(endDate)
            .map(date -> date.atZone(UTC_TIMEZONE));
    }
}

Swagger (Springfox v2.9.2) 现在显示所需的字段，但也显示 endDateWithTimezone.present和startDateWithTimezone.present ，当然都不需要作为参数:

我已经尝试了一段时间来寻找从我的 swagger 文档中隐藏这些内容的方法。我怎样才能做到这一点？

Answer 1

最终解决方案非常简单。

您必须直接在要隐藏的 getter 上使用注释 @ApiModelProperty(hidden = true)。