Swagger@ApiModelProperty示例值长时间为空

Question

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

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

我已经试过了

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

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

Answer 1

正如您在这里看到的，没有null数据类型。你有两个选择

>

您可以将

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

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

@ApiModelProperty（hidden=true）

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