Swagger ApiModelProperty access

Question

I'm using the same Object both for my Request and Response on a REST endpoint. Is it possible to annotate a property with ApiModelProperty(access = "response") and then annotate the rest endpoint method with @ApiImplicitParam(access = "response") so that the property only shows up in the swagger doc for the response object and not the request one?

score 3 · Answer 1 · answered Jun 18 '20 at 08:57

3

You can achieve the same using @ApiModelProperty(readOnly = true). Allows a model property to be designated as read only. It will hide property from request and shows for a response only.

@ApiModelProperty(readOnly = true)

answered Jun 18 '20 at 08:57

SSK

3,444
6
32
59

1

Unfortunately this did not work on swagger 1.6, the property shows up for both request and response when this annotation is applied to a java field. – user1445967 Feb 01 '21 at 19:39

score 1 · Answer 2 · answered Jun 18 '20 at 21:41

1

You better write a new DTO for this purpose

answered Jun 18 '20 at 21:41

lazarevsky

83
1
7

score 0 · Answer 3 · edited Feb 19 '18 at 10:52

0

I think you can try with

@ApiParam(access = "hidden")

Reference:
Spring Rest API with Swagger – Fine-tuning exposed documentation

edited Feb 19 '18 at 10:52

Omar Einea

2,478
7
23
35

answered Feb 19 '18 at 10:30

Man

11
2

score 0 · Answer 4 · edited Feb 20 '20 at 19:41

0

You can also try:

@Schema(accessMode=AccessMode.READ_ONLY)

edited Feb 20 '20 at 19:41

Nimantha

6,405
6
28
69

answered Feb 20 '20 at 17:56

Matt

31
1

score -2 · Answer 5 · answered Dec 05 '18 at 12:27

-2

You can use now

@ApiModelProperty(hidden=true)

answered Dec 05 '18 at 12:27

acaruci

879
9
14

Swagger ApiModelProperty access

5 Answers5