在Swagger中为请求体中的可选参数添加描述

Question

我想在Swagger文档中添加一个说明，请求主体中的一些参数是可选的。

我应该使用@ApiParam注释来进行这样的描述吗?我试图使用@ApiModelProperty(notes = "")，但它没有工作。

@PostMapping(value = "/users/")
public ResponseEntity<Object> users(@RequestBody PostUserRequest postUserRequest) {}
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class PostUserRequest {
@ApiParam(value = "This is optional parameter")
private String phone;
}

Answer 1

1. 查看@ApiModelProperty文档:doc使用value代替notes(目前未使用)
2. 关于这两个中哪一个更好的问题有一个答案链接

Answer 2

可以这样使用:

@ApiModelProperty(value = "This parameter is optional", required = false)