踩坑：swagger文档和接口定义不一致

背景：

开发时发现，Swagger文档中显示的参数和实际代码中不一致。

 

原因分析：

@ApiModel 注解中,有两个类的value值相同, 这样的情况下Swagger 会认为他们是同一个东西, 优先取第一个。

 

解决方法： 

修改定义的value值,  避免重复：

@ApiModel("列表查询请求参数")

代码定义：

@Data
@ApiModel("列表查询请求参数")
public class MerBusinessAuditListRequest extends PageInfoRequest {
    @ApiFieldValueConvertor(name ="商户客户号", method = "merCustId", provider = EnumHolder.class)
    private String userCustId;

    @ApiFieldValueConvertor(name ="商户名称", method = "merCustName", provider = EnumHolder.class)
    private String merCustName;

    @ApiFieldValueConvertor(name ="服务商客户号", method = "agentCustId", provider = EnumHolder.class)
    private String agentCustId;

    @ApiFieldValueConvertor(name ="服务商名称", method = "agentCustName", provider = EnumHolder.class)
    private String agentCustName;

    @ApiFieldValueConvertor(name ="申请时间-开始", method = "startDate", provider = EnumHolder.class)
    @JsonFormat(pattern = "yyyy-MM-dd", timezone="GMT+8")
    private String startDate;

    @ApiFieldValueConvertor(name ="申请时间-结束", method = "endDate", provider = EnumHolder.class)
    @JsonFormat(pattern = "yyyy-MM-dd", timezone="GMT+8")
    private String endDate;

    @ApiFieldValueConvertor(name ="审核类型", method = "status", provider = EnumHolder.class)
    @ApiModelProperty("审核类型: 1 已开通 0 已关闭 2 审核中 3 已驳回")
    private String status;
}

显示结果： 

 

 

声明：此博客为个人学习之用，如与其他作品雷同，纯属巧合，转载请指明出处！