Drop-in module for ASP.Net WebAPI that enables GZip
and Deflate
support.
This module is based on this blog post by Ben Foster which in turn is based on this blog post by Kiran Challa.
This code improves on their work by adding several new options, as well as fixing some issues with the original code.
You need to add the compression handler as the last applied message handler on outgoing requests, and the first one on incoming requests.
To do that, just add the following line to your App_Start\WebApiConfig.cs
file after adding all your other message handlers:
GlobalConfiguration.Configuration.MessageHandlers.Insert(0, new ServerCompressionHandler(new GZipCompressor(), new DeflateCompressor()));
This will insert the ServerCompressionHandler
to the request pipeline as the first on incoming requests, and the last on outgoing requests.
If you are doing your requests with JavaScript
you probably don't have to do do anything.
Just make sure the gzip
and deflate
values are included in the Accept-Encoding
header. (Most browsers do this by default)
You need to apply the following code when creating your HttpClient
.
var client = new HttpClient(new ClientCompressionHandler(new GZipCompressor(), new DeflateCompressor()));
client.DefaultRequestHeaders.AcceptEncoding.Add(new StringWithQualityHeaderValue("gzip"));
client.DefaultRequestHeaders.AcceptEncoding.Add(new StringWithQualityHeaderValue("deflate"));
Thats it! You should now immediately start experiencing smaller payloads when doing GET, POST, PUT, etc.
By default, both ServerCompressionHandler
and ClientCompressionHandler
compress everything.
However, this can be overriden by inserting a threshold as the first parameter like this:
var serverCompressionHandler = new ServerCompressionHandler(4096, new GZipCompressor(), new DeflateCompressor());
var clientCompressionHandler = new ClientCompressionHandler(4096, new GZipCompressor(), new DeflateCompressor());
The above code will skip compression for any request/response that is smaller than 4096 bytes
/ 4 kB
.
1.3.0 (current)
- Added attribute for disable compression for certain routes
- Fixed clearing of non-standard properties when compressing and decompressing
- Stop trying to compress requests/responses with no content
- Properly copy HTTP headers from the content that is going to be compressed
- Fixed 504 timeout error when returning
ByteArrayContent
from anApiController
- Fixed bug with content stream sometimes being disposed before returning
- Added better test coverage
- Changed default threshold for compression to 860 bytes (what Akamai uses)
- Now reports proper Content-Length
- Simplified usage
- Added support for setting a minimum content size for compressing
- First release, basic compression of server responses and client requests
- Did not support compressing POSTs and PUTs