在Swagger中为请求正文中的可选参数添加说明

qojgxg4l  于 2022-12-04  发布在  其他
关注(0)|答案(2)|浏览(200)

我想在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;
}
efzxgjgh

efzxgjgh1#

1.查看@ApiModelProperty文档:doc使用value而不是notes(当前未使用。)
1.您的问题是这两个选项中哪一个更可取link

ippsafx7

ippsafx72#

您可以这样使用:

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

相关问题