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

Question

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

本地主机：

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
    });
}

还有我的 Controller 代码只有这个方法：

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

Answer 1

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

Answer 2

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

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

    });

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

Answer 3

看看如何在.net内核中使用多个环境。 一些选项是

• 为您的不同环境（dev/stage/prod）使用launch.json文件（仅限本地开发）
• 添加名为ASPNETCORE_ENVIRONMENT的环境变量，包括development 、 stage或production
• 或者制作一个web.config部署到 IIS 并添加值

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

对于 IIS，这一切都取决于 IIS 的版本。 旧版本的IIS，相信你只能用go和web.config。

Answer 4

只需编辑您的 csproj 文件并添加以下代码段

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

Answer 5

以下对我有用。 我能够让它在 IIS 上本地工作。

1. 您需要将项目发布到一个文件夹并将 IIS 指向该文件夹。
2. 编辑 Configure 方法，将 Swagger 移出 env.IsDevelopment 并使用上面 vipul 的解决方案修复路径。

 if (env.IsDevelopment())
 {
   app.UseDeveloperExceptionPage();
 }
 app.UseSwagger();
 app.UseSwaggerUI(c =>
 {
   string swaggerJsonBasePath = string.IsNullOrWhiteSpace(c.RoutePrefix) ? "." : "..";
   c.SwaggerEndpoint($"{swaggerJsonBasePath}/swagger/v1/swagger.json", "Web API");

 });