A lightweight library that is inpired in Angular 2+ Http Client built on top of .NET Http Client that help programmers to make asynchronous http requests,
Note: This project is under development and is NOT recommend to use in production environment yet.
If you are using Package Manager:
Install-Package Rx.Http -Version 0.9.7If you are using .NET CLI
dotnet add package Rx.Http --version 0.9.7using Rx.Http;
using System.Reactive.Linq;
public class Program
{
public static async void Main()
{
//Initialize the RxHttpClient
var http = new RxHttpClient(new HttpClient())
//Retrieve a list of To-Do item and print the title of each element asynchronously
http.Get<List<Todo>>("https://jsonplaceholder.typicode.com/todos/").Subscribe(itens => {
itens.ForEach(item => Console.WriteLine(item.title));
});
//Making the same request using await
List<Todo> response = await http.Get<List<Todo>>("https://jsonplaceholder.typicode.com/todos/");
}
}You can customize your request by using options. It make possible you set query strings, headers and your custom serializer and deserializer for your request or response.
http.Get<List<Todo>>("https://jsonplaceholder.typicode.com/todos/", options =>
{
options.RequestMediaType = new JsonHttpMediaType();
options.ResponseMediaType = new JsonHttpMediaType();
options.AddHeader("Authorization", "Bearer <token>");
options.QueryStrings.Add("name", "John Doe");
});The media type represents a structure that is used to translate a mime type to a object (serializing or deserializing).
RequestMediaType is used to serialize your body content. By default is used JsonHttpMediaType
ResponseMediaType is used to deserialize your body content. By default it use the serializer based on mime type from response.
You can customize your own Media Type by implementing the interface IHttpMediaType.
A consumer is defined as a service that have common behavior for the requests. You can encapsulate the logic of all those requests in a easy way. The main advantage of using consumers is to abstract the HTTP request and its implementation details, and only work with the results from it.
The interceptors are a pre-processing unit that changes the request before it happens. It can be usefull to configure the pattern for all requests.
In this example, we need to provide the api key for all requests to The Movie Database API
The code above shows how to use Consumers and Interceptors.
public class TheMovieDatabaseConsumer : RxConsumer
{
public TheMovieDatabaseConsumer(IConsumerConfiguration<TheMovieDatabaseConsumer> configuration): base(configuration)
{
configuration.Interceptors.Add(new TheMovieDatabaseInterceptor());
}
public IObservable<Result> ListMovies() => Get<Result>("movie/popular");
}
public class TheMovieDatabaseInterceptor : RxInterceptor
{
public void Intercept(RxHttpRequest request)
{
request.QueryStrings.Add("api_key", "key");
}
}This exception is threw when the server reply with a HTTP Status different of 2xx. There's two ways to handle this exception:
var url = @"https://jsonplaceholder.typicode.com/this_page_dont_exist_hehehe/";
//With traditional try-catch block
try
{
var todos = await http.Get<List<Todo>>(url);
}
catch(RxHttpRequestException ex)
{
HttpResponseMessage response = ex.Response;
//...
}
//Or using reactive way
http.Get<List<Todo>>(url).Subscribe(response =>
{
//...
}, exception =>
{
HttpResponseMessage response = (exception as RxHttpRequestException)?.Response;
//...
})Is strongly recommended to use DI (Dependency Injection) with Rx.Http, because of HttpClientFactory, that improves HttpClient performance. For that, you must do the following:
public void ConfigureServices(ServiceCollection services)
{
services.AddHttpClient<RxHttpClient>();
//You **must** configure your consumer http client here
services.AddConsumer<TheMovieDatabaseConsumer>(http =>
{
http.BaseAddress = new Uri(@"https://api.themoviedb.org/3/");
});
}- Reactive GET, POST, PUT DELETE Http Methods
- Built-in JSON serializing and deserializing (using Newtonsoft.Json)
- Support for custom serializing and deserializing
- Logging
- Consumers and Interceptors implementation
- Error handling
- Native support for x-www-form-urlencoded and form-data
- Implement cancellation token funcionality
- Built-in XML support
- Global settings
- Provide a alternative for built-in Json serializer: System.Text.Json.JsonSerializer of .NET Core 3
- ASP.Net Core native integration