NestJS集成Mongoose时无需MongoDB连接生成OpenAPI.json的技巧

当你的NestJS应用依赖@nestjs/mongoose时，直接用NestFactory.create(AppModule)会触发模块初始化，进而尝试连接MongoDB。要避开这个问题，可以通过以下几种方式生成OpenAPI文档：

方法一：使用NestFactory.createApplicationContext替代完整应用初始化 #

createApplicationContext只会初始化模块容器，不会启动HTTP服务器或触发数据库连接等生命周期钩子，刚好满足生成OpenAPI文档的需求。修改你的脚本如下：

import { ValidationPipe } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
import * as fs from 'fs';

import { AppModule } from './app.module';

async function generateOpenapiSpecs() {
  // 使用应用上下文而非完整应用实例
  const appContext = await NestFactory.createApplicationContext(AppModule);

  const config = new DocumentBuilder()
    .setTitle('Sample Service')
    .setDescription('Api for stackoverflow')
    .setVersion('1.0')
    .build();

  // 传入应用上下文创建文档
  const document = SwaggerModule.createDocument(appContext, config);

  fs.writeFileSync('./.apim/openapi.json', JSON.stringify(document, null, 2));
  
  // 关闭上下文释放资源
  await appContext.close();
}
generateOpenapiSpecs();

方法二：为Mongoose模块配置禁用自动连接 #

如果必须使用完整应用实例，可以在生成文档的脚本中，临时修改Mongoose模块的配置，跳过真实数据库连接：

1. 在app.module.ts中支持动态配置Mongoose：

import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import { ConfigModule, ConfigService } from '@nestjs/config';

@Module({
  imports: [
    ConfigModule.forRoot(),
    MongooseModule.forRootAsync({
      imports: [ConfigModule],
      useFactory: (configService: ConfigService) => ({
        uri: configService.get<string>('MONGODB_URI'),
        // 允许通过环境变量控制是否禁用自动连接
        autoConnect: configService.get<boolean>('MONGODB_AUTO_CONNECT', true),
      }),
      inject: [ConfigService],
    }),
    // 其他模块...
  ],
})
export class AppModule {}

2. 生成文档时设置环境变量禁用自动连接：

// 在生成脚本开头添加，临时禁用自动连接
process.env.MONGODB_AUTO_CONNECT = 'false';

import { ValidationPipe } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
import * as fs from 'fs';

import { AppModule } from './app.module';

async function generateOpenapiSpecs() {
  const app = await NestFactory.create(AppModule);

  app.useGlobalPipes(new ValidationPipe());

  const config = new DocumentBuilder()
    .setTitle('Sample Service')
    .setDescription('Api for stackoverflow')
    .setVersion('1.0')
    .build();

  const document = SwaggerModule.createDocument(app, config);

  fs.writeFileSync('./.apim/openapi.json', JSON.stringify(document, null, 2));
  
  await app.close();
}
generateOpenapiSpecs();

方法三：使用@nestjs/swagger的静态分析能力（NestJS 9+） #

从NestJS 9开始，@nestjs/swagger支持通过静态分析生成文档，无需初始化任何应用实例。操作步骤如下：

1. 安装依赖：

npm install @nestjs/swagger-cli --save-dev

2. 在package.json中添加生成脚本：

{
  "scripts": {
    "generate:openapi": "swagger-cli generate --input ./src --output ./.apim/openapi.json --type json"
  }
}

3. 直接运行脚本生成文档：

npm run generate:openapi

这种方式完全跳过应用初始化，也不会触发任何数据库连接逻辑，适合纯静态生成OpenAPI规范。

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