在NestJS中从外部Mongoose Schema生成GraphQL模型

方法1：手动解析Schema动态生成GraphQL类型 #

你可以直接解析外部Mongoose Schema的字段结构，动态创建对应的GraphQL ObjectType，完全避免重复编写属性代码。

步骤1：解析Schema并生成GraphQL类型 #

遍历Mongoose Schema的paths属性，提取每个字段的类型、必填性等约束，映射为GraphQL字段：

import { UserSchema } from 'external-module';
import { ObjectType, Field } from '@nestjs/graphql';

// 动态构建GraphQL ObjectType
export const UserGraphQLType = (() => {
  const fieldMap: Record<string, any> = {};

  // 遍历所有Schema字段
  for (const [fieldName, fieldDef] of Object.entries(UserSchema.paths)) {
    // 映射Mongoose类型到GraphQL基础类型
    let gqlType: any;
    switch (fieldDef.instance) {
      case 'String':
        gqlType = String;
        break;
      case 'Number':
        gqlType = Number;
        break;
      case 'Boolean':
        gqlType = Boolean;
        break;
      case 'Date':
        gqlType = Date;
        break;
      // 嵌套文档/引用类型可根据需求扩展处理逻辑
      default:
        gqlType = String;
    }

    // 根据Mongoose的required配置设置字段是否可空
    fieldMap[fieldName] = Field(() => gqlType, { nullable: !fieldDef.isRequired });
  }

  // 动态生成带装饰器的类
  return ObjectType('User')(class User {});
})();

步骤2：在Resolver中使用动态类型 #

直接将生成的UserGraphQLType作为查询/突变的返回类型：

import { Resolver, Query } from '@nestjs/graphql';
import { InjectModel } from '@nestjs/mongoose';
import { Model } from 'mongoose';
import { User } from 'external-module'; // 外部TS接口用于类型提示
import { UserGraphQLType } from './user.graphql';

@Resolver()
export class UserResolver {
  constructor(@InjectModel('User') private userModel: Model<User>) {}

  @Query(() => [UserGraphQLType])
  async getUsers() {
    return this.userModel.find().exec();
  }
}

方法2：借助第三方工具简化转换 #

如果Schema包含嵌套文档、枚举等复杂结构，可以用工具库自动处理转换逻辑：
比如使用mongoose-to-graphql库，它能直接将Mongoose Schema转换为GraphQL类型配置，再适配NestJS的装饰器：

import { UserSchema } from 'external-module';
import { convertSchema } from 'mongoose-to-graphql';
import { ObjectType, Field, registerEnumType } from '@nestjs/graphql';

// 转换Schema为GraphQL配置
const gqlSchemaConfig = convertSchema(UserSchema, {
  // 可选配置：处理枚举、嵌套类型命名等
});

// 基于配置生成NestJS ObjectType
export const UserGraphQLType = ObjectType('User')(class User {});
// 遍历gqlSchemaConfig.fields自动添加@Field装饰器（逻辑类似方法1）

关键注意点 #

• 嵌套文档需要递归生成对应的GraphQL嵌套类型，可在遍历字段时增加判断逻辑
• 外部Schema中的枚举类型，需先通过registerEnumType注册后再映射到GraphQL
• 动态生成的类型在IDE中可能无自动提示，可结合外部导出的TS接口补充类型校验

内容的提问来源于stack exchange，提问作者arpadt