NestJS中如何仅为Swagger文档设置路径前缀？

你遇到的setBasePath无效问题，大概率是因为当前使用的NestJS Swagger依赖基于OpenAPI 3.x版本，该版本已废弃setBasePath方法，改用servers配置项定义基础路径。以下是针对你需求的具体实现：

1. 判断当前运行环境
   可以通过Nest的ConfigService读取环境变量，或直接用process.env.NODE_ENV判断：

   import { ConfigService } from '@nestjs/config';
   import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
   
   // 在main.ts或模块的configure方法中
   const configService = app.get(ConfigService);
   const isLocal = configService.get('NODE_ENV') === 'local';
   

2. 动态配置Swagger基础路径
   在DocumentBuilder中通过addServer方法根据环境添加对应基础路径：

   const swaggerConfig = new DocumentBuilder()
     .setTitle('你的API文档')
     .setDescription('API功能描述')
     .setVersion('1.0')
     // 按环境动态设置服务器基础路径
     .addServer(isLocal ? '' : '/api', isLocal ? '本地开发环境' : '线上部署环境')
     .build();
   
   const document = SwaggerModule.createDocument(app, swaggerConfig);
   SwaggerModule.setup('swagger', app, document);
   

3. 效果验证

   • 本地环境：Swagger文档内的接口路径会显示为/xxx
   • 部署环境：接口路径自动拼接/api/xxx，且Swagger页面顶部的服务器选择下拉框会显示对应环境标识

如果项目未使用ConfigService，直接用process.env也能实现：

const isLocal = process.env.NODE_ENV === 'local';

若你坚持使用旧版方式（不推荐），可检查@nestjs/swagger版本——低于4.x的版本可能仍支持setBasePath，但建议升级到最新版本使用servers配置，更贴合OpenAPI规范。

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