ParkSquare.Extensions.Http 8.1.2

HttpClient Extensions

Background

This package contains HttpClient extension methods supporting typed REST verbs from JSON, XML and URL encoded form endpoints. Correctly handles bearer tokens and cookies.

Has built-in conversion of any request object to JSON, XML, querystring or URL encoded form, including binary MultipartForm requests.

Includes Uri concatenation helpers and Cookie accessor.

For responses that return a non-2xx (i.e. failure) status code, most methods will throw an UnsuccessfulResponseException of some sort, which has a Raw property containing the response message. This is useful if the error DTO shape differs from the successful DTO shape, and removes the necessity to pollute your DTOs with error properties.

Usage Examples

Most helper methods can take a response DTO type that the response will be deserialized into, e.g. if your response object is TestResponseDto:

var response = await httpClient.GetAsync<TestResponseDto>(new Uri("https://httpbin.org/get"));

If the call requires a request body (e.g. POST), or query string parameters (e.g. GET) then you can pass your request object as a strongly typed object. It will be serialized into a JSON body, or converted into query string parameters automatically depending on the HTTP verb you are using.

var request = new TestRequestDto
{
    SomeValue = 1234    
};

var response = await httpClient.PostAsync<TestResponseDto>(new Uri("https://api.example.com"), request);

In many cases, for example where you do not expect (or care about) the response, the response type can be omitted:

var request = new TestRequestDto
{
    SomeValue = 1234    
};

await httpClient.PostAsync(new Uri("https://api.example.com"), request);

Populating Values From Response Header

If you need to populate your response DTO with a value from the response header, decorate the property with the name of the header. The value is case sensitive. Note that where a header contains multiple values, only the first one will currently be returned.

public class TestResponseDto
{
    [FromHeader("x-some-header-name")]
    public string SomeProperty { get; set; }
}

When using the [FromHeader] attribute, all other properties without that decoration will still be deserialized from the API response as normal.