Добавить описание в Swagger для необязательных параметров в теле запроса

Я хотел бы добавить в документацию 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;
}
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
Как вычислять биты и понимать побитовые операторы в Java - объяснение с примерами
Как вычислять биты и понимать побитовые операторы в Java - объяснение с примерами
В компьютерном программировании биты играют важнейшую роль в представлении и манипулировании данными на двоичном уровне. Побитовые операции...
Поднятие тревоги для долго выполняющихся методов в Spring Boot
Поднятие тревоги для долго выполняющихся методов в Spring Boot
Приходилось ли вам сталкиваться с требованиями, в которых вас могли попросить поднять тревогу или выдать ошибку, когда метод Java занимает больше...
Полный курс Java для разработчиков веб-сайтов и приложений
Полный курс Java для разработчиков веб-сайтов и приложений
Получите сертификат Java Web и Application Developer, используя наш курс.
1
0
51
2
Перейти к ответу Данный вопрос помечен как решенный

Ответы 2

Вы можете использовать так:

    @ApiModelProperty(value = "This parameter is optional", required = false)
Ответ принят как подходящий
  1. Взгляните на @ApiModelProperty документацию: doc используйте value вместо notes (в настоящее время не используется.)
  2. На ваш вопрос о том, что из этих 2 предпочтительнее, есть ответ ссылка

это не работает к сожалению

LDropl 29.11.2022 08:55

попробуйте добавить @ApiModel для уровня класса для PostUserRequest

Rustam 29.11.2022 09:11

Другие вопросы по теме