【问题标题】:Swagger UI - nullable valuesSwagger UI - 可以为空的值
【发布时间】:2019-05-09 10:24:18
【问题描述】:

我们有一个带有 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)。
如果不可能,我们是否可以重写一些 swagger 类来获得这种行为?

谢谢

【问题讨论】:

  • @ApiModelProperty(required = false, value = ".....") 公共字符串姓氏

标签: java spring-boot swagger


【解决方案1】:

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

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

【讨论】:

  • 它似乎不起作用。我们需要在swagger UI中,当我们点击“Try It Out”时,surname的值为null(我们也试过@ApiModelProperty(example = null)但是编译出错)
  • 检查一下:stackoverflow.com/questions/49032676/… 您想要达到的目标似乎是不可能的。
  • 谢谢,或许可以在 Swagger UI 中自定义 DataType?
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2023-01-04
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多