RestHttpClient 0.7.0-alpha

Simple and flexible REST client built on top of Microsoft's System.Net.HttpClient.

This is a prerelease version of RestHttpClient.
Install-Package RestHttpClient -Version 0.7.0-alpha
dotnet add package RestHttpClient --version 0.7.0-alpha
<PackageReference Include="RestHttpClient" Version="0.7.0-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add RestHttpClient --version 0.7.0-alpha
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

RestHttpClient

Simple and flexible REST client built on top of Microsoft's System.Net.HttpClient.

Usage

var client = new RestHttpClient
{
    BaseAddress = new Uri("https://jsonplaceholder.typicode.com")
};

var list = await client.GetAsync<List<Todo>>("todos");

var todo = await client.GetAsync<Todo>("todos/1");

var model = new Todo
{
    Title = "Lorem Ipsum",
    UserId = 1
};

var createdTodo = await client.PostAsync<Todo>("todos", model);

Customize serialization

Implement one of ISerializer, IDeserializer, IConverter (combination of both) and set to according property on RestHttpClient:

var client = new RestHttpClient
{
    BaseAddress = new Uri("https://jsonplaceholder.typicode.com"),
    Converter = new JsonRestConverter()
};

Authorization

For per-object authentication, just set HttpClient's default headers:

client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic","QWxhZGRpbjpvcGVuIHNlc2FtZQ==");

For per-request authentication, create an instance of RestHttpMessageHandler and set its AuthenticationHandler property as follows:
Lambda syntax:

var handler = new RestHttpMessageHandler();
{
    AuthenticationHandler = async (request) =>
    {
        request.Headers.Add("Authorization", "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==");
        return request;
    }
};

//Set handler through RestHttpClient's constructor
var client = new RestHttpClient(handler);

Regular method syntax:

//Declare handler method
async Task<HttpRequestMessage> AuthenticateRequestAsync(HttpRequestMessage request)
{
    request.Headers.Add("Authorization", "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==");
    return request;
}

//...and then somethere else:
var handler = new RestHttpMessageHandler
{
    AuthenticationHandler = AuthenticateRequestAsync
};

//Set handler through RestHttpClient's constructor
var client = new RestHttpClient(handler);

Error handling

Set a method or expression to RestHttpMessageHandler's ErrorHandler property. It will be called in case of error responses:

var handler = new RestHttpMessageHandler();
var client = new RestHttpClient(handler);
handler.ErrorHandler = async (request, response) =>
{
    //Use request and response object to determine which action to take
    if (request.RequestUri.AbsolutePath.StartsWith("/api") && response.StatusCode == HttpStatusCode.Unauthorized)
    {
        //In this case we set Authentication global header...
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", "QWxhZGRpbjpvcGVuIHNlc2FtZQ==");
        ///... and then return a copy of the request, which will be resent.
        return request.Clone();
    }

    //If you don't wish to resend the request, just return null;
    return null;
};

Please note that ErrorHandler method won't be called again if the returned request also fails.

If there isn't an error handler set or if the error handler doesn't return a Request object, RestException will be thrown:

try
{
    var item = await client.GetAsync<Todo>("todos/800");
}
//Use RestException's Request, Response or Content properties to determine how to handle the Exception
catch (RestException ex) when (ex.Response?.StatusCode == HttpStatusCode.NotFound)
{
    Console.WriteLine("Content not found.");
}
catch (RestException ex)
{
    Console.WriteLine("Request failed, check out its content: ");
    Console.Write(ex.Content);
    throw;
}

Less common cases

For less common cases, write your request using the HttpRequestMessage class and send it throuth one of the available SendAsync overloads:

var json = "{ title: 'Lorem Ipsum', userId: 1 }";

var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    Content = new StringContent(json, Encoding.UTF8, "application/json"),
    RequestUri = new Uri("todos", UriKind.Relative)
};

var response = await client.RestSendAsync(request);

Assert.True(response.IsSuccessStatusCode);

Of course you can always use any of HttpClient's methods for any case.

RestHttpMessageHandler

As you may have thought, Authorization and Error handling are actually done by RestHttpMessageHandler and not by RestHttpClient, and hence you can also use its capabilities with the regular HttpClient.

You can also use any other HttpMessageHandler-derived type with RestHttpClient, but please note that Authorization and Error handling capabilities won't be present on RestHttpClient if it doesn't implement IRestMessageHandler.

Version 0.5.0

v0.5.0 had those Rest-prefixes before RestHttpClient's specific calls. Some changes have been made and these prefixes don't exist anymore, so just get rid of them in your calls! ;)

RestHttpClient

Simple and flexible REST client built on top of Microsoft's System.Net.HttpClient.

Usage

var client = new RestHttpClient
{
    BaseAddress = new Uri("https://jsonplaceholder.typicode.com")
};

var list = await client.GetAsync<List<Todo>>("todos");

var todo = await client.GetAsync<Todo>("todos/1");

var model = new Todo
{
    Title = "Lorem Ipsum",
    UserId = 1
};

var createdTodo = await client.PostAsync<Todo>("todos", model);

Customize serialization

Implement one of ISerializer, IDeserializer, IConverter (combination of both) and set to according property on RestHttpClient:

var client = new RestHttpClient
{
    BaseAddress = new Uri("https://jsonplaceholder.typicode.com"),
    Converter = new JsonRestConverter()
};

Authorization

For per-object authentication, just set HttpClient's default headers:

client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic","QWxhZGRpbjpvcGVuIHNlc2FtZQ==");

For per-request authentication, create an instance of RestHttpMessageHandler and set its AuthenticationHandler property as follows:
Lambda syntax:

var handler = new RestHttpMessageHandler();
{
    AuthenticationHandler = async (request) =>
    {
        request.Headers.Add("Authorization", "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==");
        return request;
    }
};

//Set handler through RestHttpClient's constructor
var client = new RestHttpClient(handler);

Regular method syntax:

//Declare handler method
async Task<HttpRequestMessage> AuthenticateRequestAsync(HttpRequestMessage request)
{
    request.Headers.Add("Authorization", "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==");
    return request;
}

//...and then somethere else:
var handler = new RestHttpMessageHandler
{
    AuthenticationHandler = AuthenticateRequestAsync
};

//Set handler through RestHttpClient's constructor
var client = new RestHttpClient(handler);

Error handling

Set a method or expression to RestHttpMessageHandler's ErrorHandler property. It will be called in case of error responses:

var handler = new RestHttpMessageHandler();
var client = new RestHttpClient(handler);
handler.ErrorHandler = async (request, response) =>
{
    //Use request and response object to determine which action to take
    if (request.RequestUri.AbsolutePath.StartsWith("/api") && response.StatusCode == HttpStatusCode.Unauthorized)
    {
        //In this case we set Authentication global header...
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", "QWxhZGRpbjpvcGVuIHNlc2FtZQ==");
        ///... and then return a copy of the request, which will be resent.
        return request.Clone();
    }

    //If you don't wish to resend the request, just return null;
    return null;
};

Please note that ErrorHandler method won't be called again if the returned request also fails.

If there isn't an error handler set or if the error handler doesn't return a Request object, RestException will be thrown:

try
{
    var item = await client.GetAsync<Todo>("todos/800");
}
//Use RestException's Request, Response or Content properties to determine how to handle the Exception
catch (RestException ex) when (ex.Response?.StatusCode == HttpStatusCode.NotFound)
{
    Console.WriteLine("Content not found.");
}
catch (RestException ex)
{
    Console.WriteLine("Request failed, check out its content: ");
    Console.Write(ex.Content);
    throw;
}

Less common cases

For less common cases, write your request using the HttpRequestMessage class and send it throuth one of the available SendAsync overloads:

var json = "{ title: 'Lorem Ipsum', userId: 1 }";

var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    Content = new StringContent(json, Encoding.UTF8, "application/json"),
    RequestUri = new Uri("todos", UriKind.Relative)
};

var response = await client.RestSendAsync(request);

Assert.True(response.IsSuccessStatusCode);

Of course you can always use any of HttpClient's methods for any case.

RestHttpMessageHandler

As you may have thought, Authorization and Error handling are actually done by RestHttpMessageHandler and not by RestHttpClient, and hence you can also use its capabilities with the regular HttpClient.

You can also use any other HttpMessageHandler-derived type with RestHttpClient, but please note that Authorization and Error handling capabilities won't be present on RestHttpClient if it doesn't implement IRestMessageHandler.

Version 0.5.0

v0.5.0 had those Rest-prefixes before RestHttpClient's specific calls. Some changes have been made and these prefixes don't exist anymore, so just get rid of them in your calls! ;)

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
0.7.0-alpha 104 4/8/2019
0.6.0-alpha 89 3/28/2019
0.5.0-alpha 146 3/19/2019
0.4.0-alpha 86 3/19/2019
0.3.1-alpha 88 3/19/2019
0.3.0-alpha 84 3/19/2019
0.2.0-alpha 262 3/18/2019
0.1.0-alpha 93 3/18/2019