在前端页面的下拉框参数,在swagger上却没有下拉框供选择,只有输入框,同学们不知道这个输入框该怎么输入才是合法的、正确的,如果swagger上面也有下拉框就好了。
针对这个问题做了个调研,swagger上确实可以有下拉框,而且也比较容易实现,只需在@ApiImplicitParam注解里面加上allowableValues="选项1,选项2,选项3,……"即可,多选也很简单,加上allowMultiple = true。代码如下:
@ApiOperation(value = "测试swagger下拉框")
@ApiImplicitParams({
@ApiImplicitParam(name = "type", value = "类型", dataType = "String", paramType = "query",
allowableValues = "苹果,荔枝,菠萝", allowMultiple = true)
})
@RequestMapping(value = "/select", method = {RequestMethod.GET})
public String[] mystyle(String[] type) {
return type;
}
在swagger ui上Ctrl + 鼠标单击即可多选,效果图:
补充:
针对Java Bean的@ApiModelProperty注解,发现有allowableValues属性,但却没有allowMultiple属性。也就是说,在controller的方法里用Java Bean来接收参数,在Java Bean里对每个成员变量配置的swagger文档,支持单选的下拉框,不支持下拉框多选。不过我们可以转变一下思路,把需要多选的变量,在controller的方法上用@ApiImplicitParam注解重新定义一遍,在swagger ui上依然可以看到多选下拉框的效果。虽然是重复工作,但也是权宜之计吧。
关于swagger ui上的下拉框能不能支持id:text这种形式,即在页面上显示用户名,传参的时候传用户id。答案是不能,至少现在springfox-swagger2是不支持的。
springfox-swagger2版本的问题,2.5.x - 2.7.x 版本支持多选,2.8.0版本后不支持下拉框多选。
欢迎各位指正!!