.NET 6 WebAPI如何配置Swagger去除访问路径中的index.html后缀

安全阿岳

2026-9-25

解决方案

你可以通过两种方案实现访问`api/docs`时路径无`index.html`后缀、无跳转直接加载页面：

方案1（推荐）：内置URL重写中间件实现

通过内部转发规则处理请求，浏览器地址栏不会变化，实现成本极低，无需额外安装第三方依赖：

// 注意：重写中间件必须放在UseSwagger之前注册
app.UseRewriter(new RewriteOptions()
    .AddRewrite(@"^api/docs$", "api/docs/index.html", skipRemainingRules: true));

app.UseSwagger();
app.UseSwaggerUI(x =>
{
    x.SwaggerEndpoint("/swagger/v1/swagger.json", "API");
    x.RoutePrefix = "api/docs";
});

方案2：自定义端点直接返回Swagger页面

如果不想用重写中间件，可直接注册根路径端点返回Swagger的默认页面内容：

app.UseSwagger();
app.UseSwaggerUI(x =>
{
    x.SwaggerEndpoint("/swagger/v1/swagger.json", "API");
    x.RoutePrefix = "api/docs";
});

// 注册/api/docs根路径的处理端点
app.MapGet("/api/docs", async (HttpContext context) =>
{
    var swaggerUiOptions = context.RequestServices.GetRequiredService<IOptions<SwaggerUIOptions>>().Value;
    using var indexStream = swaggerUiOptions.IndexStream();
    using var streamReader = new StreamReader(indexStream);
    var htmlContent = await streamReader.ReadToEndAsync();
    context.Response.ContentType = "text/html";
    await context.Response.WriteAsync(htmlContent);
});