如何在 ASP.NET 核心中更改 Swagger 的基本 url

Question

默认情况下，当您在 ASP.NET Core 项目中启用 swagger 时，它在 url 上可用：

http://localhost:<random_port>/swagger/ui

我想使用不同的基本网址而不是/swagger/ui 。 我如何/在哪里可以配置它？

我发现对于旧版本，您可以配置RootUrl但在 ASP.NET Core 中没有类似的方法：

.EnableSwagger(c =>
{
    c.RootUrl(req => myCustomBasePath);
});

Answer 1

新的 swagger 版本为您提供了一个名为 RoutePrefix 的属性。

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    c.RoutePrefix = "docs";
});

应该适用于 .net 核心

Answer 2

对于 ASP.NET Core 2（并使用Swashbuckle.AspNetCore.Swagger -Version 4.0.1 ），可以完成一些更改默认 swagger UI 基本 URL 的完整配置。

如果要将“mycoolapi”添加到默认 swagger UI URL 的开头，例如： http://<server>/mycoolapi/swagger ，请执行以下操作：

在您的 Startup.cs 配置方法中：

    app.UseSwagger(c =>
    {
        c.RouteTemplate = "mycoolapi/swagger/{documentname}/swagger.json";
    });


    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/mycoolapi/swagger/v1/swagger.json", "My Cool API V1");
        c.RoutePrefix = "mycoolapi/swagger";
    });

然后，如果您当前有您的 launchSettings 在启动时在 swagger UI 上启动浏览器（用于开发目的），请类似地更新您的 launchSettings.json 文件配置文件部分：

  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "mycoolapi/swagger",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "MyProject.Web": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "mycoolapi/swagger",
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }

Answer 3

1. 打开launchSettings.json文件。
2. 根据您的设置，在“配置文件”节点下，您应该有一个或多个配置文件。 在可能的情况下，我有“IIS Express”和另一个以我的项目名称命名的（例如 WebApplication1 ），现在将launchUrl条目更改为“launchUrl”：“swagger”解决了我的问题。
3. 如果这不起作用并且您有其他配置文件执行相同操作并进行测试。

Answer 4

您也可以在 Config 中执行此操作

app.UseSwaggerUI(c =>
            {
                c.RoutePrefix = string.Empty;
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "MY API");
            });

Answer 5

我不得不仔细阅读原始文档，因为上述所有解决方案都不起作用。 Startup.cs 中的这段代码对我有用：

app.UseSwagger();
app.UseSwaggerUI(c => {
    c.SwaggerEndpoint($"./v1/swagger.json", "SapWeb v1");
});

我的站点是 IIS 中的子站点。 所以，起初，我必须设置 PathBase：

app.UsePathBase($"{pathbase}");

Answer 6

其他答案在 .NET 5 中对我不起作用。这是我向路由添加“文档”的方法

app.UseSwagger(c => c.RouteTemplate = "/swagger/docs/{documentName}/swagger.json");
app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/docs/v2/swagger.json", "My API"));

Answer 7

在 StartUp 类的 Configure 方法中启用中间件的UseSwaggerUi()扩展方法需要两个变量。 甲baseRoute这是对swagger/ui按预设和swaggerUrl这是对swagger/v1/swagger.json默认。 只需提供不同的 baseRoute。

//Swagger will be available under '/api' url
app.UseSwaggerUi("api");

如果人们想了解有关为 ASP.NET Core 配置 Swagger 的更多信息，我已经写了一篇博客文章开始： https ://dannyvanderkraan.wordpress.com/2016/09/09/asp-net-core-1- 0-web-api-automatic-documentation-with-swagger-and-swashbuckle/