java - Swagger UI - 可为空值

Question

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

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

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

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

Surname 应该是字符串或 null(默认为 null)。
如果不可能，我们可以重写一些 swagger 类来获得这种行为吗？

谢谢

Answer 1

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

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