Как описать объект в swagger, у которого мы точно не знаю имена свойств?

Question

[Владимир Голубь]

Получаю объект вида: [название продукта]: DTO с его свойствами

export class ProductsDto {
  [product: string]: ProductDto
}

export class ProductDto {
  @ApiResponseProperty()
  id: number;

  @ApiResponseProperty()
  price: number;
}

В выводе получаю пустой объект, использую NestJS.

Как это сделать?

Answer 1

[Dmitriy Grape]

А что вам мешает написать ProductDTO[] вместо создания отдельного DTO? Это тоже будет работать, а ещё лучше врубите transform: true в конфигурации валидации в вашем приложении, чтобы наверняка, так сказать.

Если у вас в приложении не включена валидация, то советую сделать это глобально в файле app.ts

Читать только если вы новичёк в Nest

Вы же не пишете отдельные ValidationPipe для каждого Create эндпоинта?

app.useGlobalPipes(new ValidationPipe({ transform: true }));

Потом легко вытаскиваем это в контроллере

@Body() productsDto: ProductDto[]

Comments

[Владимир Голубь]

В том что я возвращаю объект, а не массив

{
  product1: { ... },  // ProductDto
  product2: { ... }   // ProductDto
}

[Владимир Голубь]

Трансформ у меня добавлен

[Dmitriy Grape]

Владимир Голубь, так а в чём проблема возвращать просто массив этих объектов?

[Владимир Голубь]

Rag’n’ Code Man, не проблема, странно что swagger не позволяет такое описать

[Dmitriy Grape]

Я не представляю как такое реализовать средствами TS, в Swagger наверное тоже так думают