Rocket.Libraries.HttpRequestDecompression

A library that decompresses HTTP requests, supports gzip and deflate

Getting started.

1. Installation

Grab the nuget package from https://www.nuget.org/packages/Rocket.Libraries.HttpRequestDecompression

2. ASP.Net Core Web App

1. In the ConfigureServices method of your Startup.cs file, register decompression services for dependancy injection.

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpRequestDecompressionSupport();
    // Add you other services
}

2. Then in the Configure method of your Startup.cs file, add the decompression middleware.

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Be sure to add the middleware before any other middleware that may require an uncompressed request.
    // Infact it is probably best to add the decompression middleware before all others.
    app.UseHttpRequestDecompression();
}

3. Your compressed requests from your clients MUST include the header Content-Encoding. For uncompressed requests on the other hand, the Content-Encoding header should be left out.

Important

Scope of Operation

This middleware shall only decompress requests with Content-Encoding gzip or deflate.

• If you don't include the Content-Encoding header, then the request shall be assumed to be uncompressed and the middleware shall pass it along the pipe line.
• If Content-Encoding header is anything else besides gzip or deflate, an exception is thrown.

Tests

• Included are the tests for the library, the codebase is fairly small and coverage is currently at ~ 92%.