我想在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;
}
2条答案
按热度按时间efzxgjgh1#
1.查看
@ApiModelProperty
文档:doc使用value
而不是notes
(当前未使用。)1.您的问题是这两个选项中哪一个更可取link
ippsafx72#
您可以这样使用: