Quiron.HttpClient 1.4.17

What is the Quiron.HttpClient?

Project created to group endpoint call methods to facilitate the development and consumption of APIs

Give a Star! ⭐

If you find this project useful, please give it a star! It helps us grow and improve the community.

Namespaces and Dependencies

• ✅ Quiron.HttpClient
• ✅ Newtonsoft.Json
• ✅ System.Net.Http
• ✅ Polly
• ✅ Polly.Extensions.Http

Protected Properties

protected const string _CERTIFICATE_HEADER = "X-Certificate";
protected const string _CLIENT_ID_HEADER = "X-Client-Id";
protected const string _CLIENT_SECRET_HEADER = "X-Client-Secret";
protected virtual string BaseDomain => string.Empty; // you need to implement your base domain here ⚠️
protected virtual int Timeout => 50;
protected virtual Dictionary<string, string> Headers => new() {
            { "Accept", "application/json" },
            { "Accept-Encoding", "gzip,deflate,br" },
            { "Connection", "keep-alive" }
        };

Policies

public static IAsyncPolicy<HttpResponseMessage> RetryPolicy(ILogger? logger = null) =>
            HttpPolicyExtensions
                .HandleTransientHttpError()
                .WaitAndRetryAsync(
                    retryCount: 5,
                    sleepDurationProvider: retryAttempt => TimeSpan.FromMilliseconds(500 * Math.Pow(2, retryAttempt)),
                    onRetry: (outcome, timespan, retryAttempt, context) =>
                    {
                        if (logger is null) return;

                        logger.LogWarning("Retry {RetryAttempt} after {Delay}ms to {Url}",
                            retryAttempt, timespan.TotalMilliseconds, outcome.Result?.RequestMessage?.RequestUri);
                    }
                );

public static IAsyncPolicy<HttpResponseMessage> TimeoutPolicy =>
           Policy.TimeoutAsync<HttpResponseMessage>(25);

public static IAsyncPolicy<HttpResponseMessage> CircuitBreakerPolicy =>
            HttpPolicyExtensions
                .HandleTransientHttpError()
                .CircuitBreakerAsync(
                    handledEventsAllowedBeforeBreaking: 5,
                    durationOfBreak: TimeSpan.FromSeconds(25);

public static IAsyncPolicy<HttpResponseMessage> ResiliencePolicy(ILogger? logger = null) =>
            Policy.WrapAsync(
                RetryPolicy(logger),
                TimeoutPolicy,
                CircuitBreakerPolicy
            );

⚠️ IMPORTANT: You can use the policies separately, but use the ResiliencePolicy which already includes the following policies in the correct order: RetryPolicy, TimeoutPolicy and CircuitBreakerPolicy.

Your Program.cs

services.AddHttpClient<IHttpApi, HttpApi>()
    .ConfigurePrimaryHttpMessageHandler(() =>
    {
        return new HttpClientHandler { MaxConnectionsPerServer = 20, AllowAutoRedirect = true };
    })
    .AddPolicyHandler((serviceProvider, request) =>
    {
        var logger = serviceProvider.GetRequiredService<ILogger<HttpApi>>();
        return PollyPolicies.ResiliencePolicy(logger);
    });

Methods

Task<(byte[] content, string contentType)> DownloadAsync<T>(HttpMethod method, string endPoint, object? obj = null, string? token = "");
Task<(byte[] content, string contentType)> DownloadAsync<T>(string endPoint, string? token = "");
Task<T?> GetObjectAsync<T>(string endPoint, string token);
Task<T?> PostObjectAsync<T>(string endPoint, object obj, string token = "");
Task<T?> PutObjectAsync<T>(string endPoint, object obj, string token);
Task<T?> PatchObjectAsync<T>(string endPoint, object obj, string token);

Supports:

• ✅ .NET Standard 2.1
• ✅ .NET 10 through 9 (including latest versions)
• ⚠️ Legacy support for .NET Core 3.1 and older (with limitations)

About

Quiron.HttpClient was developed by EliasRMJ under the MIT license.