Encamina.Enmarcha.Net.Http 8.1.6-preview-07

HTTP

This project provides utilities related to HTTP, covering aspects such as the most common media types and common constants, ultimately providing a collection of useful tools for HTTP.

Setup

Nuget package

First, install NuGet. Then, install Encamina.Enmarcha.Net.Http from the package manager console:

PM> Install-Package Encamina.Enmarcha.Net.Http

.NET CLI:

First, install .NET CLI. Then, install Encamina.Enmarcha.Net.Http from the .NET CLI:

dotnet add package Encamina.Enmarcha.Net.Http

How to use

Media types

MediaTypeNames provides common media type (formerly known as MIME type) names for file formats and format contents.

Console.WriteLine(Encamina.Enmarcha.Net.Http.MediaTypeNames.Image.Jpeg);
// image/jpeg

Console.WriteLine(Encamina.Enmarcha.Net.Http.MediaTypeNames.Application.Json);
// application/json

Console.WriteLine(Encamina.Enmarcha.Net.Http.MediaTypeNames.Text.Csv);
// text/csv

MediaTypeFileExtensionMapper a mapping between file extensions and media types (former MIME). The main difference with FileExtensionContentTypeProvider is that this considers various media types per extension, which is usefull for scenarios like for example zip files which can be identified as application/zip, application/zip-compressed, or application/x-zip-compressed.

var mediaTypeFileExtensionMapper = new MediaTypeFileExtensionMapper();

// Gets the media types mapped to the given extension
var zipMediaTypes = mediaTypeFileExtensionMapper.GetMediaTypesFromExtension(".zip");
// zipMediaTypes => application/zip, application/zip-compressed, application/x-zip-compressed

// Gets the current mappings between extensions and media types.
zipMediaTypes = mediaTypeFileExtensionMapper.Mappings[".zip"];
// zipMediaTypes => application/zip, application/zip-compressed, application/x-zip-compressed

// Gets the extensions mapped to the given media type.
var zipExtension = mediaTypeFileExtensionMapper.GetExtensionsFromMediaType("application/zip");
// zipExtension => .zip

Alternatively, you can create a new instance of MediaTypeFileExtensionMapper with your own mappings or merge new mappings with the default ones.

var customMappings = new Dictionary<string, IEnumerable<string>>()
{
    { ".odt", new[] { @"application/vnd.oasis.opendocument.text" } },
};

// It only contains the mapping for .odt.
var customMediaTypeFileExtensionMapper = new MediaTypeFileExtensionMapper(customMappings);

// It contains all the default mappings plus the mapping for .odt.
var mergedMediaTypeFileExtensionMapper = new MediaTypeFileExtensionMapper(customMappings, mergeWithDefaultMappings: true);

Constants

A collection of properties that represent common constant values. It includes HTTP headers that can be used as custom HTTP headers, for example, as Constants.HttpHeaders.CorrelationId or Constants.HttpHeaders.SourceUrl.

HttpContextExtensions

Extension helper methods when working with an HttpContext.

For example, in a Web API, you may want to retrieve the value of a request header:

// ...

HttpContext httpContext;

// ...

// Reads values from the request header. A default value to return if the header is not found.
var myCustomHeaderValue = myhttpContext.ReadValueFromRequestHeader("my-custom-header", defaultValue: "no-custom-header");