A example about how to create paginated DTO class with NestJS Swagger

paginated-response-nestjs-swagger.ts

import { Controller, Get } from "@nestjs/common";
import {
  ApiOkResponse,
  ApiOperation,
  ApiProperty,
  ApiTags,
} from "@nestjs/swagger";

class PaginationMeta {
  /**
   * the amount of items on this specific page
   */
  @ApiProperty({ description: "Total items in current page" })
  itemCount: number;
  /**
   * the total amount of items
   */
  @ApiProperty({ description: "Total items in all pages" })
  totalItems: number;
  /**
   * the amount of items that were requested per page
   */
  @ApiProperty({ description: "Limit value" })
  itemsPerPage: number;
  /**
   * the total amount of pages in this paginator
   */
  @ApiProperty({ description: "Number of available pages" })
  totalPages: number;
  /**
   * the current page this paginator "points" to
   */
  @ApiProperty({ description: "Index of current page" })
  currentPage: number;
}

export class PaginatedApiResponse<T> {
  data: T[];

  @ApiProperty({ type: PaginationMeta })
  meta: PaginationMeta;
}

export function SwaggerPaginatedApiResponse<T>(
  type: T,
  name: string
): typeof PaginatedApiResponse {
  class ExtendPaginatedApiResponse<T> extends PaginatedApiResponse<T> {
    @ApiProperty({ type: [type] })
    public data: T[];
  }

  Object.defineProperty(ExtendPaginatedApiResponse, "name", {
    value: name,
  });

  return ExtendPaginatedApiResponse;
}

@ApiTags("users")
@Controller("/api/users")
export class UsersController {
  @ApiOperation({
    summary: "List users",
    description: "Note: This action is only designed for admin",
  })
  @ApiOkResponse({
    type: SwaggerPaginatedApiResponse(User, "ListUsersResponse"),
  })
  @Get()
  async list() {}
}

Nice job! Thanks for sharing