ASP.NET 5 脱离Visual Studio构建镜像运行容器无法访问Swagger

ASP.NET Core Web API默认模板中，Swagger相关中间件仅在开发环境下注册启用，对应代码逻辑如下：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseSwagger();
        app.UseSwaggerUI();
    }
    // 其余中间件逻辑
}

Visual Studio以Docker方式启动项目时，会自动向容器注入ASPNETCORE_ENVIRONMENT=Development环境变量，符合开发环境判定条件，Swagger可正常访问。手动运行容器时未传入该环境变量，程序默认使用Production环境，Swagger中间件不会加载，因此访问对应路径返回404。

可根据使用场景选择以下两种方案：

方案1：临时调试场景，运行容器时传入开发环境变量 #

修改docker run命令，通过-e参数注入环境变量即可：

docker run -p 8855:80 -e ASPNETCORE_ENVIRONMENT=Development kicaj29/webapplication1:1.0.0

启动完成后即可正常访问http://localhost:8855/swagger/index.html

方案2：需要在所有环境都暴露Swagger的场景，修改代码逻辑 #

移除Swagger注册逻辑的环境判断，修改后的代码如下：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 移除if (env.IsDevelopment())判断，全局启用Swagger
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "你的API名称 v1");
        // 如需根路径直接打开Swagger，可取消注释下方配置
        // c.RoutePrefix = string.Empty;
    });
    
    // 其余中间件逻辑
}

修改后重新构建镜像运行即可，无需额外传入环境变量。

如果按上述方案操作后仍无法访问，可通过以下命令查看容器运行日志，排查启动错误：

docker logs <你的容器ID/容器名称>

注意：生产环境若不需要对外暴露接口文档，不推荐全局开启Swagger，避免接口信息泄露

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