Отображение значения атрибута модели по умолчанию в пользовательском интерфейсе Swagger

Я использую Spring Boot Java и Swagger 2 для документирования своих API. Какую аннотацию Spring можно использовать для отображения значения по умолчанию mydoggie в пользовательском интерфейсе Swagger?

Желаемый результат


spring-boot swagger swagger-ui
person Sara Sara    schedule 14.11.2019    source источник
comment
Отвечает ли это на ваш вопрос? Управление свойством файла swagger по умолчанию   -  person Vladas Maier    schedule 14.11.2019
comment
К сожалению нет, пробовал, не помогло.   -  person Sara Sara    schedule 14.11.2019

Ответы (1)


arrow_upward
1
arrow_downward

Вы можете добавить пример и значение по умолчанию для отображения в Swagger 2 с помощью этой аннотации:

@ApiModelProperty(value = "value to show", example = "example to show")

Я надеюсь, что это помогает

person pepevalbe    schedule 14.11.2019
comment
@ApiModelProperty(value= description ) предназначен только для отображения описания свойства. docs.swagger. io/swagger-core/v1.5.0/apidocs/io/swagger/ - person Sara Sara; 14.11.2019
comment
@SaraSara К сожалению, нет другого варианта, если вы останетесь с Swagger 2.0. Однако OpenAPI 3.0 предоставляет атрибут примера. В моем проекте с Swagger 2.0 я решаю эту проблему, добавляя информацию о значении по умолчанию в поле описания, подобное этому @ApiModelProperty(value = "my value (default: my default value)") - person Vladas Maier; 14.11.2019