how to set the response to be an array in the swagger response using DTOs

Question

some-dto.ts

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

      @ApiProperty()
      age: number;

      @ApiProperty()
      breed: string;
    }

I don't want response something like this:

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

but my response must be array of like dto objects. I want smth like soo

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

score 25 · Accepted Answer · answered Mar 09 '20 at 12:25

25

have you tried something like this:

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

Let me know if it helps

answered Mar 09 '20 at 12:25

A. Maitre

2,985
21
25

Do you have an idea if you want to respond with a list of lists? Like CreateCatDto[][]? – user1961312 Nov 01 '22 at 11:16
I personally haven't had to deal with such structure in past experiences. You would have to check on the web to see if this is supported and how to implement. If supported my guess is that you would need to tweak things in order to make it work Let us know if you find a solution though ! – A. Maitre Nov 20 '22 at 15:15

score 12 · Answer 2 · answered Mar 09 '20 at 12:37

12

I found another solution we can wrap in array like this

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

answered Mar 09 '20 at 12:37

har17bar

728
1
8
22

Nice to know array type can be inferred from using the DTO type within an array ! – A. Maitre Mar 09 '20 at 12:47

Remi Mélisson · Answer 3 · 2023-07-04T12:48:28.947

And if you need to deal with multiple types :

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

Additionally, you might need to include them in then controller beforehand :

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

how to set the response to be an array in the swagger response using DTOs

3 Answers3