java Swagger@ApiModelProperty示例值长时间为null

Question

我使用SpringFox和Swagger UI编写API文档
我有一个DTO，其中有一个类型为Long的属性。它99%的时间都没有填充，所以我想通过将属性值设置为null，在文档中演示这一事实。所以我想在示例部分中使用这个JSON

{
  /* ... */
  "legacyId": null
}

我已经试过了

@ApiModelProperty(value = "legacyId", example = null)
public Long getLegacyId() {
    return legacyId;
}

但我得到了一个警告“属性值必须是常量”。我还能做什么

Answer 1

正如您所看到的here，没有空数据类型。你有两个选择

1. 你可以定义为

   @ApiModelProperty(example = "null")  > This will display as "null"
   

   这将误导用户并可能导致NPE

2. @ApiModelProperty(hidden = true)

就个人而言，我更喜欢第二个，因为当spring从控制器中的UI映射json时，如果前端没有传递任何内容，它将自动为null