使用 Swagger 隐藏枚举值 - 如何在 Swagger 中控制枚举值显示
Swagger 默认情况下会显示所有枚举值作为可用值。如果您希望某些枚举值在 Swagger 中不可见,可以使用 @ApiModelProperty 注解来指定可见的枚举值。
例如,假设有一个名为 Status 的枚举类,其中包含 ACTIVE,INACTIVE 和 DELETED 三个枚举值。如果您只希望在 Swagger 中显示 ACTIVE 和 INACTIVE,则可以在 Status 枚举中添加 @ApiModelProperty 注解并设置 hidden = true,如下所示:
public enum Status {
@ApiModelProperty(hidden = true)
DELETED,
ACTIVE,
INACTIVE
}
这样,Swagger 将只显示 ACTIVE 和 INACTIVE 作为可用值。
请注意,使用 @ApiModelProperty 注解需要导入 io.swagger.annotations.ApiModelProperty 类。
原文地址: https://www.cveoy.top/t/topic/ckPN 著作权归作者所有。请勿转载和采集!