📦 Key Takeaways: Compress API responses with Brotli/Gzip to reduce bandwidth, improve load times, and save money. Up to 90% smaller payloads!
Large JSON responses are slow. Response compression makes them fast.
🚀 Setup Compression
// Program.cs - Enable compression
using Microsoft.AspNetCore.ResponseCompression;
var builder = WebApplication.CreateBuilder(args);
// ✅ Configure compression
builder.Services.AddResponseCompression(options =>
{
// ✅ Use Brotli (best compression)
options.Providers.Add<BrotliCompressionProvider>();
options.Providers.Add<GzipCompressionProvider>();
// ✅ Compress everything except images
options.MimeTypes = ResponseCompressionDefaults.MimeTypes;
options.MimeTypes.Add("application/json");
options.MimeTypes.Add("text/plain");
});
// ✅ Configure compression level
builder.Services.Configure<BrotliCompressionProviderOptions>(options =>
{
options.Level = CompressionLevel.Fastest; // Or Optimal, SmallestSize
});
builder.Services.Configure<GzipCompressionProviderOptions>(options =>
{
options.Level = CompressionLevel.Fastest;
});
var app = builder.Build();
// ✅ Use compression middleware
app.UseResponseCompression();
app.MapGet("/api/products", async (IProductService service) =>
{
var products = await service.GetProductsAsync();
return Results.Json(products); // ✅ Automatically compressed!
});
app.Run();
💡 Advanced: Custom Compression
// ✅ Custom compression provider
public class CustomCompressionProvider : ICompressionProvider
{
public string EncodingName => "br";
public bool SupportsFlush => true;
public Stream CreateStream(Stream outputStream)
{
// ✅ Use Brotli with custom settings
return new BrotliStream(outputStream, CompressionLevel.SmallestSize);
}
}
// ✅ Register custom provider
builder.Services.AddResponseCompression(options =>
{
options.Providers.Add<CustomCompressionProvider>();
});
// ✅ Conditional compression
app.Use(async (context, next) =>
{
// Don't compress small responses
context.Response.OnStarting(() =>
{
if (context.Response.ContentLength < 1024)
{
context.Response.Headers.Remove("Content-Encoding");
}
return Task.CompletedTask;
});
await next();
});
📊 Compression Results
| Payload Type | Original | Gzip | Brotli |
|---|---|---|---|
| JSON Products (1000) | 850KB | 120KB | 85KB |
| JSON Orders (500) | 425KB | 65KB | 42KB |
| Text HTML | 120KB | 18KB | 12KB |
| CSV Export | 2.4MB | 280KB | 190KB |
