@nestjs/swagger 插件中的 NestJS typeorm 分页类型

分页类型"/>

@nestjs/swagger 插件中的 NestJS typeorm 分页类型

我有一个端点，它返回一个带有分页的列表。 我正在尝试使用 nestjs/swagger 插件自动收集端点和 DTO 等。 插件适用于所有端点，但返回类型为 typeorm 分页的端点除外。

  findAll(
    @Query('page', new DefaultValuePipe(1), ParseIntPipe) page : number,
    @Query('limit', new DefaultValuePipe(10), ParseIntPipe) limit : number,
    @Query('domain') domain: string,
  ): Promise<Pagination<webContent>> {
    return this.webService.findAll({ page, limit }, domain);
  }

网页内容是：

export default class webContent {
  @PrimaryColumn()
  domain: string;

  @ManyToMany(() => WebCategory)
  @JoinTable()
  categories: WebCategory[];
}

任何解决方案？

玩这个，例如你可以添加一个构造函数来映射属性：

import { Type, applyDecorators } from '@nestjs/common';
import { ApiExtraModels, ApiOkResponse, ApiProperty, getSchemaPath } from '@nestjs/swagger';

import { PaginationResponseDto } from '@shared';

export class PaginationModel<T> implements PaginationResponseDto<T> {
    @ApiProperty({ isArray: true })
    public readonly data: T[];

    @ApiProperty({ example: 1 })
    public readonly total: number;

    @ApiProperty({ example: 1 })
    public readonly page: number;

    @ApiProperty({ example: 1 })
    public readonly pages: number;
}

还有一个控制器装饰器：

export const ApiPaginatedResponse = <TModel extends Type<any>>(model: TModel) => {
    return applyDecorators(
        ApiExtraModels(PaginationModel),
        ApiOkResponse({
            description: 'Successfully received model list',
            schema: {
                allOf: [
                    { $ref: getSchemaPath(PaginationModel) },
                    {
                        properties: {
                            data: {
                                type: 'array',
                                items: { $ref: getSchemaPath(model) },
                            },
                        },
                    },
                ],
            },
        })
    );
};

用法示例：

@Get()
@ApiOperation({ summary: 'find paginated users' })
@ApiPaginatedResponse(UserModel)
// public async findUsers(...otherLogic