Add description in Swagger for optional parameters in request body

Question

I would like to add a description in Swagger documentation that some parameters in request body are optional.

Should I use @ApiParam annotation for such description ? I tried to use @ApiModelProperty(notes = "") but it didnt work.

@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;
}

score 1 · Answer 1 · answered Nov 29 '22 at 07:31

1

You can use like this:

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

answered Nov 29 '22 at 07:31

Pavan

543
4
16

score 1 · Accepted Answer · answered Nov 29 '22 at 07:36

1

Take a look for @ApiModelProperty documentation: doc use value instead of notes (Currently not in use.)
There is an answer for your question about which of this 2 is preferable link

answered Nov 29 '22 at 07:36

Rustam

378
2
6

it doesnt work unfortunately – LDropl Nov 29 '22 at 07:55
try to add `@ApiModel` for class level for `PostUserRequest` – Rustam Nov 29 '22 at 08:11

Add description in Swagger for optional parameters in request body

2 Answers2