Springboot整合swagger Boolean类型字段以is开头字段不显示问题

最新推荐文章于 2025-07-07 18:42:17 发布

原创最新推荐文章于 2025-07-07 18:42:17 发布 · 1.3k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java #swagger2 #spring boot

在Springboot应用中使用swagger进行API文档生成时遇到一个问题，Boolean类型的字段如果以is开头，在生成的文档中字段名会缺失is前缀，且其描述信息未正确显示。例如`needActivation`和`isWriteOffImmediately`字段。总结建议避免使用以is开头的Boolean字段名，以防止类似问题。

Springboot整合swagger Boolean类型字段以is开头字段不显示问题

我的字段

	
	/**
     * 激活规则（是否需要激活）
     */
    @ApiModelProperty("激活规则（是否需要激活）")
    private Boolean needActivation;
    
	/**
     * 激活后立即核销（是否激活立即核销 0否 1是）
     */
    @ApiModelProperty("激活后立即核销（是否激活立即核销 0否 1是）")
    private Boolean isWriteOffImmediately;

显示结果（字段少了is，参数说明没有）

参数名称               		参数说明           	 是否必须     		数据类型
needActivation	      激活规则（是否需要激活）     false			boolean
writeOffImmediately							   false	  	    boolean

总结：Boolean尽量不要以is开头