如何为Nest.js中ManyToOne关系添加ApiModelProperty装饰器并生成文档

没问题！在Nest.js里给TypeORM的多对一关联属性添加Swagger文档完全可以实现，你遇到的Promise拒绝错误大概率是因为循环引用或者用了过时的装饰器导致的。我来给你一步步讲正确的做法：

首先，先确认你用的是最新版的@nestjs/swagger。从v4版本开始，旧的ApiModelProperty装饰器已经被弃用，官方推荐使用ApiProperty来替代，这可能是你报错的原因之一。

接下来，处理多对一关联的核心要点是：用工厂函数（箭头函数）指定关联实体的类型，而不是直接引用实体类。因为如果两个实体互相引用（比如User里有OneToMany到Post，Post里有ManyToOne到User），直接写type: User会触发循环依赖，导致初始化时出现未处理的Promise拒绝。

给你一个完整的示例：

假设你有User和Post两个实体，Post的owner是多对一关联到User：

User实体（user.entity.ts） #

import { Entity, Column, OneToMany } from 'typeorm';
import { BaseEntity } from './base.entity';
import { Post } from './post.entity';
import { ApiProperty } from '@nestjs/swagger';

@Entity()
export class User extends BaseEntity {
  @Column()
  @ApiProperty({ description: '用户用户名' })
  username: string;

  @Column()
  @ApiProperty({ description: '用户邮箱' })
  email: string;

  // 一对多关联Post
  @OneToMany(() => Post, post => post.owner)
  @ApiProperty({ type: () => [Post], description: '用户发布的所有帖子' })
  posts: Post[];
}

Post实体（post.entity.ts） #

import { Entity, Column, ManyToOne, JoinColumn } from 'typeorm';
import { BaseEntity } from './base.entity';
import { User } from './user.entity';
import { ApiProperty } from '@nestjs/swagger';

@Entity()
export class Post extends BaseEntity {
  @Column()
  @ApiProperty({ description: '帖子标题' })
  title: string;

  @Column('text')
  @ApiProperty({ description: '帖子内容' })
  content: string;

  // 多对一关联User
  @ManyToOne(() => User, user => user.posts)
  @JoinColumn({ name: 'owner_id' })
  @ApiProperty({ 
    type: () => User, 
    description: '帖子的创建者（关联用户实体）' 
  })
  owner: User;
}

这样配置后，Swagger文档里会正确显示owner属性是User类型，并且展开显示User的所有字段。

为什么这样能解决Promise拒绝错误？ #

当你用() => User而不是直接User时，相当于延迟了类型的解析，避免了实体初始化时的循环引用问题。TypeScript在处理装饰器时，会先执行箭头函数，此时实体类已经完成初始化，不会再出现未处理的Promise拒绝。

如果你还在使用旧版本的@nestjs/swagger（v3及以下） #

虽然官方不推荐，但如果你暂时无法升级，也可以用ApiModelProperty，但同样要遵循工厂函数的写法：

@ApiModelProperty({ type: () => User })
owner: User;

最后，确保你的Swagger模块配置正确，比如在main.ts里正确设置：

import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  
  const config = new DocumentBuilder()
    .setTitle('你的API文档')
    .setDescription('API描述')
    .setVersion('1.0')
    .build();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api', app, document);

  await app.listen(3000);
}
bootstrap();

按照这个方法配置后，你的多对一关联属性就能正常出现在Swagger文档里了！

内容的提问来源于stack exchange，提问作者Miguel A. C.