Swagger UI-可为空的值

时间:2019-05-09 10:24:18

标签: java spring-boot swagger

我们有一个带有Springfox-swagger2和springfox-swagger-ui(版本2.9.2)的SpringBoot(版本1.5.12)REST Api

在Swagger UI中是否可以具有可为空的属性(使用swagger.yaml配置文件或swagger注释)?

我们需要发送的有效载荷是这样的:

{ 
  id: 2
  name: 'test'
  surname: null
}

Surname应该为字符串或null(默认为null)。
如果不可能的话,我们可以重写一些招摇类以获得这种行为吗?

谢谢

1 个答案:

答案 0 :(得分:0)

是的,可以具有可为空/可选的属性。为此,请将required@ApiModelProperty)批注中的io.swagger.annotations属性设置为false(默认情况下实际上为false)。

@ApiModelProperty(required = false, value = "Surname")
private String surname;