Скрытый параметр в springdoc-openapi не работает

У меня есть приложение Spring Boot версии 2.3.0. и springdoc-openapi-webflux-ui в версии 1.4.1.

У меня есть аннотированный параметр в действии, подобном этому.

parameters = {
@Parameter(
    hidden = true, schema = @Schema(implementation = Boolean.class),
    in = ParameterIn.QUERY, name = DO_NOT_FORWARD
)

При hidden = true я ожидал, что этот параметр не будет отображаться в swagger-ui. Но это. Я неправильно понял этот параметр или он не выполняет то, что должен был делать?

Я хочу, чтобы этот параметр был в api-docs, чтобы сгенерировал клиент, способный использовать этот параметр, но я хочу, чтобы он был невидимым в swagger-ui


spring-boot springdoc springdoc-openapi-ui
person vanillaSugar    schedule 19.06.2020    source источник
comment
Можете ли вы предоставить фрагмент метода? Текущий фрагмент кода не дает правильного представления о том, где и как вы его используете.   -  person Debargha Roy    schedule 03.08.2020

Ответы (1)


arrow_upward
1
arrow_downward

Просто убедитесь, что имя в аннотации @Parameter является точным именем параметра операции, который вы хотите скрыть.

Вы также можете посмотреть документацию:

Если у вас все еще есть проблема с настройкой, вы можете добавить код образца HelloController, который воспроизводит вашу проблему, или вы можете добавить ссылку на минимальный воспроизводимый образец в github.

person brianbro    schedule 25.06.2020
comment
У вас есть рабочий пример кода? У меня все еще не работает. Я постараюсь опубликовать свой код или создать образец - person vanillaSugar; 26.06.2020