如何在ASP.NET Core Web API远程开发环境启用Swagger并区分环境配置

1. 定义自定义开发环境标识 #

ASP.NET Core支持自定义环境名称，我们可以新增RemoteDevelopment环境，用来标记团队共用的远程开发服务器，和本地的Development环境做明确区分。

2. 拆分环境专属配置文件 #

• 保留原有的appsettings.Development.json：存放本地开发专属配置，比如本地数据库连接字符串、本地调试参数等。
• 新增appsettings.RemoteDevelopment.json：存放远程开发服务器的专属配置，比如服务器端数据库连接字符串、团队共用的调试配置等。
• 通用配置（比如Swagger基础设置、接口路由规则）依然放在appsettings.json中。

3. 修改Swagger启用逻辑 #

把原来仅判断Development环境的代码，改成同时包含Development和RemoteDevelopment两个环境：

var allowedSwaggerEnvironments = new[] { "Development", "RemoteDevelopment" };
if (allowedSwaggerEnvironments.Contains(app.Environment.EnvironmentName))
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

4. 配置远程服务器的环境变量 #

在远程开发服务器上，将ASPNETCORE_ENVIRONMENT环境变量设置为RemoteDevelopment：

• 命令行启动：Windows执行set ASPNETCORE_ENVIRONMENT=RemoteDevelopment，Linux执行export ASPNETCORE_ENVIRONMENT=RemoteDevelopment，再启动应用。
• IIS部署：在站点的「配置编辑器」中，选择system.webServer/aspNetCore节点，修改environmentVariables里的ASPNETCORE_ENVIRONMENT值为RemoteDevelopment。
• Docker部署：在Dockerfile或docker-compose.yml中添加配置：ENV ASPNETCORE_ENVIRONMENT=RemoteDevelopment。

5. 配置加载逻辑说明 #

ASP.NET Core的配置加载优先级为：环境变量 > 特定环境配置文件 > 通用配置文件，因此：

• 本地开发时，环境为Development，会加载appsettings.json + appsettings.Development.json，同时启用Swagger。
• 远程服务器运行时，环境为RemoteDevelopment，会加载appsettings.json + appsettings.RemoteDevelopment.json，同样启用Swagger，且使用服务器端的专属配置参数。

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