swagger踩坑之请求类不显示具体字段

快敲代码去

已于 2024-03-12 18:58:18 修改

阅读量910

点赞数 2

文章标签： java 开发语言

于 2024-03-12 18:53:52 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_45561263/article/details/136660069

版权

文章讲述了在使用Swagger时，如何确保枚举字段在文档中显示，以及如何通过@ApiModelProperty注解控制其在UI中的可见性。通过实例展示了不加注解和添加注解后，字段在SwaggerUI中的不同呈现。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

swagger踩坑之请求类不显示具体字段

省流：枚举字段需要加上@ApiModelProperty注解

过程复现：

TestEnum 枚举不加注解，swagger的UI类不显示详细字段

@Data
@Accessors(chain = true)
@ApiModel(value = "test对象", description = "test")
public class TestParam implements Serializable {
    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "主键ID")
    private String id;

    @ApiModelProperty(value = "编码")
    private String code;

    @ApiModelProperty(value = "名称")
    private String name;

    @Dict(dicCode = "TestEnum")
//    @ApiModelProperty(value = "枚举状态", hidden = true)
    private TestEnum testStatus;

}

图示
在这里插入图片描述

TestEnum 枚举添加注解，详细字段出现。

经过测试，把String类型字段的注解去掉，字段生成不受影响。

@Data
@Accessors(chain = true)
@ApiModel(value = "test对象", description = "test")
public class TestParam implements Serializable {
    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "主键ID")
    private String id;

    @ApiModelProperty(value = "编码")
    private String code;

//    @ApiModelProperty(value = "名称")
    private String name;

    @Dict(dicCode = "TestEnum")
    @ApiModelProperty(value = "枚举状态", hidden = true)
    private TestEnum testStatus;

}

图示
在这里插入图片描述