Plinth.HttpApiClient 1.8.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Plinth.HttpApiClient --version 1.8.1
                    


                    

                
NuGet\Install-Package Plinth.HttpApiClient -Version 1.8.1
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="Plinth.HttpApiClient" Version="1.8.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Plinth.HttpApiClient" Version="1.8.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Plinth.HttpApiClient" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Plinth.HttpApiClient --version 1.8.1
                    


                    

                
#r "nuget: Plinth.HttpApiClient, 1.8.1"
#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. 
#:package Plinth.HttpApiClient@1.8.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Plinth.HttpApiClient&version=1.8.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Plinth.HttpApiClient&version=1.8.1
                    


                            Install as a Cake Tool

README

Plinth.HttpApiClient

HTTP Api Client framework built on MS HttpClient

Adds logging and tracing to HttpClient based API clients.

There are two supported approaches to building clients, autogenerated clients and manually built clients.

Auto generating clients with nswag

  • install nodejs at least 12+
  • npm install -g nswag
  • run this powershell, substituting the link to the swagger spec
    $targetServiceSwaggerUrl = "{url or path to openapi spec}"
    $targetServiceName = "{client class name}"
    $namespace = "{client namespace}"

    $nswagParams = @(
        'openapi2csclient',
        '/runtime:net100',  # Use net100, net90, or net80 depending on your target framework
        "/input:\`"${targetServiceSwaggerUrl}\`"",
        "/classname:${targetServiceName}Client",
        "/namespace:${namespace}",
        "/output:${targetServiceName}Client.cs",
        '/operationGenerationMode:SingleClientFromOperationId',
        '/generateClientInterfaces:true',
        '/injectHttpClient:true',
        '/useBaseUrl:false',
        '/disposeHttpClient:false',
        '/generateOptionalParameters:true'
        '/exceptionClass:NSwagException',
        '/generateExceptionClasses:true',
        '/parameterDateTimeFormat:o',
        '/generateNullableReferenceTypes:true',
        '/excludedParameterNames:X-Plinth-Auth'
    )

    nswag @nswagParams | Out-Host

     services.AddHttpApiHandlerClient<INSwagClient, NSwagClient>(
        "NSwagClient",
        configureClient: c =>
        {
            c.BaseAddress = new Uri("http://localhost:5000");
        });

Manually building clients

Build a manual api client by deriving from BaseHttpApiClient and implementing API methods using HttpRequestMessage extensions. Example below:

public class MyClient : BaseHttpApiClient
{
    public MyClient(HttpClient client) : base("MyApi", client)
    {
    }

    public async Task<ModelObject?> GetThing(int parameter)
    {
        return await HttpGet("/api/values/thing")
	        .AddQueryParameter("param", parameter)
	        .ExecuteAsync<ModelObject>();
    }

    public async Task<ModelObject?> CreateThing(ModelObject modelObject)
    {
        return await HttpPost("/api/values/thing")
            .SetJsonBody(modelObject)
            .SetAuthorization("myApiToken")
            .ExecuteAsync<ModelObject>();
    }
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Plinth.HttpApiClient:

Package Downloads
Plinth.HttpApiClient.Polly

Polly extensions for Plinth.HttpApiClient

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.8.1 142 12/11/2025
1.8.0 494 11/13/2025
1.8.0-b211.72089fd9 234 11/12/2025
1.7.4 552 8/6/2025
1.7.3 108 8/2/2025
1.7.2 344 3/16/2025
1.7.1 787 12/12/2024
1.7.0 2,618 11/12/2024
1.6.6 797 11/8/2024
1.6.5 652 8/31/2024
1.6.4 570 8/2/2024
1.6.3 1,890 5/15/2024
1.6.2 508 2/16/2024
1.6.1 4,323 1/5/2024
1.6.0 324 11/30/2023
1.5.10-b186.aca976b4 134 11/30/2023
1.5.9 255 11/29/2023
1.5.9-b174.64153841 130 11/23/2023
1.5.9-b172.dfc6e7bd 103 11/17/2023
1.5.9-b171.4e2b92e2 139 11/4/2023
1.5.8 17,770 10/23/2023
1.5.7 8,042 7/31/2023
1.5.6 13,841 7/13/2023
1.5.5 355 6/29/2023
1.5.4 1,218 3/7/2023
1.5.3 448 3/3/2023
1.5.2 1,011 1/11/2023
1.5.2-b92.7c961f5f 247 1/11/2023
1.5.0 760 11/9/2022
1.5.0-b88.7a7c20cd 227 11/9/2022
1.4.7 5,369 10/20/2022
1.4.6 998 10/17/2022
1.4.5 959 10/1/2022
1.4.4 953 8/16/2022
1.4.3 866 8/2/2022
1.4.2 913 7/19/2022
1.4.2-b80.7fdbfd04 256 7/19/2022
1.4.2-b74.acaf86f5 231 6/15/2022
1.4.1 1,229 6/13/2022
1.4.0 966 6/6/2022
1.3.8 2,820 4/12/2022
1.3.7 895 3/21/2022
1.3.6 865 3/17/2022
1.3.6-b67.ca5053f3 267 3/16/2022
1.3.6-b66.4a9683e6 262 3/16/2022
1.3.5 943 2/23/2022
1.3.4 1,153 1/20/2022
1.3.3 926 12/29/2021
1.3.2 796 12/11/2021
1.3.1 679 11/12/2021
1.3.0 668 11/8/2021
1.2.3 1,877 9/22/2021
1.2.2 965 8/20/2021
1.2.1 849 8/5/2021
1.2.0 2,357 8/1/2021
1.2.0-b37.a54030b9 333 6/24/2021
1.1.6 6,582 3/22/2021
1.1.5 1,905 3/9/2021
1.1.4 3,014 2/27/2021
1.1.3 1,553 2/17/2021
1.1.2 1,506 2/12/2021
1.1.1 1,820 2/1/2021
1.1.0 1,595 12/16/2020
1.1.0-b27.b66c309b 432 11/15/2020
1.0.12 3,907 10/18/2020
1.0.11 1,642 10/6/2020
1.0.10 1,662 9/30/2020
1.0.9 1,732 9/29/2020
1.0.8 1,759 9/26/2020
1.0.7 1,751 9/19/2020
1.0.6 1,685 9/3/2020
1.0.5 1,845 9/2/2020
1.0.4 2,002 9/1/2020
1.0.3 1,609 9/1/2020
1.0.2 1,617 8/29/2020
1.0.1 1,668 8/29/2020
1.0.0 1,703 8/29/2020
1.0.0-b1.c22f563d 416 8/28/2020

Refit/Refitter support