在 IIS 上部署 API 时，Swagger UI 不显示

Question

好吧，我在我的 API 文档中使用 Swagger，它在本地主机上运行良好，当我将它托管在 IIS 上时，问题就开始了。由于某种原因，它不再起作用了

localhost:

https://localhost:44381/swagger/index.html

api:

http://200.155.29.14/SimuladorFrete/Swagger/index.html

当我在 ISS 中部署 Swagger 后尝试打开它时，我得到的只是一个空白页面和一个 500 内部服务器错误，这并没有说明异常。

这是我的配置方法 (startup.cs)

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();

    }
    app.UseHttpsRedirection();

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
    app.UseSwagger();
    app.UseStaticFiles();
    app.UseSwaggerUI(c =>
    {
        if (env.IsDevelopment())
        {
            c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web API V1");
        }
        else
        {
            // To deploy on IIS
            c.SwaggerEndpoint("/SimulaFrete/swagger/v1/swagger.json", "Web API V1");
        }

    });
}

这是我的 ConfigureServices 方法：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers().AddNewtonsoftJson();

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1",

      new OpenApiInfo
      {

          Title = "Simulador de frete por Unidade",
          Version = "v1",
          Description = "Métodos da API de simulação de frete",
          Contact = new OpenApiContact
          {
              Name = "Catalde Technology",
              Url = new Uri("https://www.catalde.com"),
              Email = "cicero.catalde@catalde.com"
          }
      });

        string caminhoAplicacao =
            PlatformServices.Default.Application.ApplicationBasePath;
        string nomeAplicacao =
            PlatformServices.Default.Application.ApplicationName;
        string caminhoXmlDoc =
            Path.Combine(caminhoAplicacao, $"{nomeAplicacao}.xml");

        c.IncludeXmlComments(caminhoXmlDoc);
        c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); //This line
    });
}

我的控制器代码只有这个方法：

[HttpPost]
public ContentResult Post([FromBody]dadosFrete xml)
{
    // code logic
}

Answer 1

试试这个。设置相对路径。

app.UseSwaggerUI(c =>
    {
        string swaggerJsonBasePath = string.IsNullOrWhiteSpace(c.RoutePrefix) ? "." : "..";
        c.SwaggerEndpoint($"{swaggerJsonBasePath}/swagger/v1/swagger.json", "My API");

    });

如果此解决方案不起作用。然后检查发布设置。问题是运行 dotnet publish 和 -r Release 不会生成 XML 文件。但是，dotnet publish 和 -r Debug 实际上会生成文件。这解释了为什么人们只有在部署到本地以外的环境时才会遇到这个问题。您可以在 Project > Your Project properties > Build Tab

中简化查找

Answer 2

您需要在您的条件中临时添加production子句，才能在生产环境中看到swagger。请参阅所附图片中黄色突出显示的部分。 env.IsProduction()

Answer 3

看看如何在 .net 核心中使用 multiple environments。一些选项是

为您的不同环境使用 launch.json 文件 (dev/stage/prod)（仅限本地开发）
使用 development、stage 或 production

ASPNETCORE_ENVIRONMENT

或者制作一个web.config部署到IIS并添加值

<PropertyGroup>
<EnvironmentName>Development</EnvironmentName>
</PropertyGroup>

对于IIS，这完全取决于IIS的版本。旧版本的 IIS，我相信你只能用 web.config.

在 IIS 上部署 API 时，Swagger UI 不显示

Swagger UI not displaying when deploying API on IIS

c#

asp.net-web-api

swagger

swashbuckle

asp.net-core