Pdsr.Http.Extensions 3.5.0.442

There is a newer version of this package available.
See the version list below for details.
dotnet add package Pdsr.Http.Extensions --version 3.5.0.442
NuGet\Install-Package Pdsr.Http.Extensions -Version 3.5.0.442
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Pdsr.Http.Extensions" Version="3.5.0.442" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Pdsr.Http.Extensions --version 3.5.0.442
#r "nuget: Pdsr.Http.Extensions, 3.5.0.442"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Pdsr.Http.Extensions as a Cake Addin
#addin nuget:?package=Pdsr.Http.Extensions&version=3.5.0.442

// Install Pdsr.Http.Extensions as a Cake Tool
#tool nuget:?package=Pdsr.Http.Extensions&version=3.5.0.442

Pdsr HttpClient Helper

A helper library for using with Http Api Calls

Getting Started

you need to install the package, add to DI and then use it in services.

  1. install the package dotnet add package Pdsr.HttpClient and for extensions dotnet add package Pdsr.HttpClient.Extensions.
  2. Inject an System.Net.HttpClient to the DI container.
  3. Implement the IPdsrClientBase or inherit the abstract class PdsrClientBase and override any methods required.
public class SomeService
{
    private readonly IPdsrClient _client;
    public SomeService(IPdsrClient client) => _client = client;

    public async Task SomeAsyncMethod(string someRouteId, string someQueryStringValue, CancellationToken cancellationToken = default)
    {
        var results = await _client.Url("https://example.com/api").AddUrl(someRouteId)
            .AddQueryString ("key" , someQueryStringValue)
            .Accept("application/vnd.api.custom+custom")
            .OnBadRequest( (res)=>
            {
                // do something
            })
            .OnException( (ex) =>
            {
                // do something about the exception
            })
            .OnNoFound( (res) =>
            {
                // do something when resource not found.
            })
            // and any other status code and so on
            // or add handler to the Client to run on certain situations
            // or add handler to the HttpRequestMessage on certain situations
            .Post(new { Something = "some value" })
            .SnakeCase()
            .SendAsync<SomeModelSupposeToDeserializeTo>(cancellationToken);
        return results;
    }
}

you need to override the abstract methods GetAuthorizationHeader if your api needs authentication and implement the authorization logic there.

protected abstract Task SetAuthorizationHeader(HttpRequestMessage request, CancellationToken cancellationToken = default);

You can also log all requests and responses in the inherited class, to have one code log all requests.

protected abstract Task WriteLog(HttpResponseMessage response, long ellapsed, CancellationToken cancellationToken = default);

Use the required Serializer/Deserializer Name casing.

Right now, it only supports CamelCase by default and SnakeCase can be used as well.

In case of deserialization, if your API does not return any model or you want to get anything else other than Model, such as Stream, String, or the HttpResponseMessage itself, you can use the respected method such as GetStream or GetString and override the SendAsync to return the Message itself.

Contribute

Please refer to contribute.

Documents

Under Construction.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.7.1 957 9/5/2023
3.7.0 179 7/19/2023
3.7.0-preview.1 64 4/27/2023
3.6.3 2,441 2/20/2023
3.6.2 233 2/20/2023
3.6.1 365 11/11/2022
3.6.0 330 11/11/2022
3.5.4 391 8/26/2022
3.5.3 376 8/26/2022
3.5.1.445 796 4/17/2022
3.5.0.443 418 4/17/2022
3.5.0.442 414 4/17/2022