How to set the response description information when the response parameter in swagger is Boolean or integer

Problem description

     Project use swagger Display document information , Now there is an enterprise user information verification interface for recruiters , Response parameters will only return true or false, How to add the description information of the return field in the response parameter column of the interface document (true: Check success ;false: Check failed )?

    swagger The description information of the response parameters in is through the entity class @ApiModelProperty add to , But if you return a Boolean Or other non object types , There is no place to add this annotation . Here is my summary of the treatment plan .

Solution

    1. Comment directly from the method description @ApiOperation Add response result description information , As long as the front end can understand the meaning of the returned fields .

 @ApiOperation(" Check the enterprise user information of the recruiter ( Return parameter description :true: Check success ;false: Check failed )")
    @GetMapping("/checkRecruitBusinessInfo")
    public ResultVo<Boolean> checkRecruitBusinessInfo(@Validated BusinessInfoDto businessInfoDto) throws Exception {
    
        Boolean businessInfoRight = newStoreService.checkRecruitBusinessInfo(businessInfoDto);
        return ResultVoUtil.success(businessInfoRight);
    }

The interface document is shown below :

2. Custom return parameter object , Label the returned field information .
Custom add return parameter description object :

@ApiModel(" Check the return parameter information of the recruiter's enterprise user information ")
@Data
public class ReturnInfo {
    

    @ApiModelProperty(value = " Check the enterprise user information of the recruiter :true: Check success ;false: Check failed ",dataType = "Boolean",example = "false")
    private Boolean businessInfoRight;
}

modify controller Object information returned in :

    @ApiOperation(" Check the enterprise user information of the recruiter ")
    @GetMapping("/checkRecruitBusinessInfo")
    public ResultVo<ReturnInfo> checkRecruitBusinessInfo(@Validated BusinessInfoDto businessInfoDto) throws Exception {
    
        Boolean businessInfoRight = newStoreService.checkRecruitBusinessInfo(businessInfoDto);
        ReturnInfo returnInfo = new ReturnInfo();
        returnInfo.setBusinessInfoRight(businessInfoRight);
        return ResultVoUtil.success(returnInfo);
    }

The modified interface document , The field description information has been displayed in the marked place :

     In actual development, as long as the front and back ends can understand the meaning of parameter transmission and use the first method ; But for OCD players like me , There is a problem if the meaning of the field is not displayed in the response parameters , But the second way is really a little redundant , It's really not a wise way to create objects just to show problems . If you are usually about swagger There are other ways to deal with this scenario , Leave a comment in the comments section !