如何使用 DTO 将响应设置为 swagger 响应中的数组

Question

some-dto.ts

    export class CreateCatDto {
      @ApiProperty()
      name: string;

      @ApiProperty()
      age: number;

      @ApiProperty()
      breed: string;
    }

我不想要这样的回应：

  @ApiOkResponse(
      description: 'Cat object',
      type: CreateCatDto
    )

但我的回应必须是像 dto 对象的数组。我想要 smth 像 soo

    ApiOkResponse(
          description: 'The record has been successfully removed.',
          schema: {
            type: 'array',
            properties: {
              obj: {
                type: CreateCatDto
              }
            }
          }
        )

Answer 1

你有没有尝试过这样的事情：

@ApiOkResponse(
    description: 'Cat object',
    type: CreateCatDto,
    isArray: true // <= diff is here
)

让我知道它是否有帮助

Answer 2

如果您需要处理多种类型：

@ApiOkResponse({
  description: 'More or less dangerous animals',
  schema: {
    type: 'array',
    items: {
      oneOf: [
        { $ref: getSchemaPath(CreateCatDto) },
        { $ref: getSchemaPath(CreateAlligatorDto) }
      ],
    },
  },
})

此外，您可能需要事先将它们包含在控制器中：

@Controller("noahsark")
@ApiExtraModels(CreateCatDto, CreateAlligatorDto)
export class NoahsArkController {
...
}

Answer 3

我找到了另一个解决方案，我们可以像这样包装在数组中

@ApiOkResponse(
  description: 'Cat object',
  type: [CreateCatDto]
)