.NET 8 API大负载请求下Swagger UI崩溃/卡顿问题求助

针对你遇到的.NET 8 Web API大负载GET接口在Swagger UI中卡顿、崩溃，但Postman调用正常的问题，可尝试以下几种针对性方案：

1. 调整Swagger UI渲染配置 #

Swagger UI默认会将完整响应内容渲染为结构化DOM元素，大体积JSON会导致浏览器DOM节点过载，这是卡顿/崩溃的核心原因。可以通过配置关闭自动渲染或简化展示逻辑：

在Program.cs中修改Swagger配置：

builder.Services.AddSwaggerGen();

app.UseSwagger();
app.UseSwaggerUI(options =>
{
    // 关闭模型自动展开，减少DOM元素数量
    options.DefaultModelsExpandDepth(-1);
    options.DefaultModelExpandDepth(-1);
    // 禁用默认的响应结构化渲染，改为提供下载链接
    options.ConfigObject.AdditionalItems["requestSnippetsEnabled"] = false;
});

修改后Swagger UI不会在页面上渲染完整大响应，而是提供响应内容的下载选项，避免浏览器资源耗尽。

2. 启用API响应压缩 #

给API添加响应压缩，缩小传输的payload体积，降低Swagger UI的处理压力：

在Program.cs中添加：

builder.Services.AddResponseCompression(options =>
{
    options.EnableForHttps = true;
    options.MimeTypes = ResponseCompressionDefaults.MimeTypes.Concat(
        new[] { "application/json" });
});

// 需在UseSwagger之前启用
app.UseResponseCompression();

压缩后1.74MB的JSON体积会大幅减小，Swagger UI处理起来更轻松。

3. 给大负载接口添加分页 #

一次性返回5000条数据本身不符合REST API最佳实践，添加分页既能解决Swagger的问题，也能优化API整体性能：

示例分页接口代码：

[HttpGet]
public async Task<IActionResult> GetAll([FromQuery] int page = 1, [FromQuery] int pageSize = 100)
{
    var totalCount = await _context.YourEntities.CountAsync();
    var paginatedItems = await _context.YourEntities
        .Skip((page - 1) * pageSize)
        .Take(pageSize)
        .AsNoTracking()
        .ToListAsync();
    
    return Ok(new 
    { 
        TotalCount = totalCount, 
        CurrentPage = page, 
        PageSize = pageSize, 
        Data = paginatedItems 
    });
}

分页后每次返回的数据量大幅降低，Swagger UI可正常渲染响应内容。

4. 替换Swagger UI的JSON渲染方式 #

如果需要在Swagger中查看响应内容，可通过自定义JS替换默认的结构化渲染为纯文本展示，减少DOM开销：

1. 在Program.cs的Swagger配置中注入自定义脚本：

app.UseSwaggerUI(options =>
{
    options.InjectJavascript("/swagger-custom.js");
});

2. 在项目wwwroot目录下创建swagger-custom.js文件：

window.onload = function() {
    const originalRender = window.ui.renderResponse;
    window.ui.renderResponse = function(httpResponse, content) {
        if (typeof content === 'object') {
            const pre = document.createElement('pre');
            pre.style.maxHeight = '600px';
            pre.style.overflowY = 'auto';
            pre.textContent = JSON.stringify(content, null, 2);
            return pre;
        }
        return originalRender(httpResponse, content);
    };
};

纯文本格式的JSON展示比默认的结构化DOM渲染更节省浏览器资源。

内容的提问来源于stack exchange，提问作者Nabeel A.