Доступ к Swagger ApiModelProperty

Я использую один и тот же объект как для своего запроса, так и для ответа на конечной точке REST. Можно ли аннотировать свойство с помощью ApiModelProperty(access = "response"), а затем аннотировать оставшийся метод конечной точки с помощью @ApiImplicitParam(access = "response"), чтобы свойство отображается только в документе swagger для объекта ответа, а не для объекта запроса?


java spring-mvc swagger-2.0
person hello_world_infinity    schedule 09.09.2015    source источник

Ответы (5)


arrow_upward
1
arrow_downward

Вы можете добиться того же, используя @ApiModelProperty(readOnly = true). Позволяет обозначить свойство модели как доступное только для чтения. Он скроет свойство от запроса и покажет только ответ.

@ApiModelProperty(readOnly = true)
person SSK    schedule 18.06.2020
comment
К сожалению, это не сработало в swagger 1.6, свойство отображается как для запроса, так и для ответа, когда эта аннотация применяется к полю java. - person user1445967; 01.02.2021

arrow_upward
0
arrow_downward

Я думаю, вы можете попробовать с

@ApiParam(access = "hidden")

Ссылка:
API Spring Rest с Swagger — Fine -настройка открытой документации

person Man    schedule 19.02.2018

arrow_upward
0
arrow_downward

Вы также можете попробовать:

@Schema(accessMode=AccessMode.READ_ONLY)
person Matt    schedule 20.02.2020

arrow_upward
0
arrow_downward

Вам лучше написать новый DTO для этой цели

person lazarevsky    schedule 18.06.2020

arrow_upward
-2
arrow_downward

Вы можете использовать сейчас

@ApiModelProperty(hidden=true)
person acaruci    schedule 05.12.2018