Плагин NestJS Swagger OpenAPI CLI — исключить определенные свойства

Мне нравится, как плагин CLI избавляет меня от необходимости писать @ApiProperty() везде.

Однако в некоторых моих сущностях, хотя я хочу, чтобы БОЛЬШИНСТВО свойств было @ApiProperty(), я хочу, чтобы некоторые не были такими.

Я не могу найти в документации ничего, что позволило бы мне ИСКЛЮЧИТЬ определенные поля из автоматического получения @ApiProperty().

Кто-нибудь знает, как?

Документирование API с помощью Swagger на Springboot
Документирование API с помощью Swagger на Springboot
В предыдущей статье мы уже узнали, как создать Rest API с помощью Springboot и MySql .
0
0
90
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Вы можете явно добавить @ApiHideProperty(), и CLI не добавит к нему декоратор @ApiProperty().

Ха... спасибо, Джей. Итак, это скрывает свойство из вывода схемы... но если я ПОЛУЧУ объект по идентификатору, все скрытые свойства все равно будут возвращены. Разве этого можно ожидать?!

Gabriel Richards 21.10.2022 01:31

Чтобы исключить свойство из ответа, вам нужно следовать документации по сериализации и использовать @Exclude() из class-transformer

Jay McDoniel 21.10.2022 03:23

Идеально, большое спасибо! Теперь я больше понимаю Nest.

Gabriel Richards 21.10.2022 18:13

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