Plinth.HttpApiClient 1.8.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Plinth.HttpApiClient --version 1.8.0
                    


                    

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


                            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.0
                    


                    

                
#r "nuget: Plinth.HttpApiClient, 1.8.0"
#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.0
#: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.0
                    


                            Install as a Cake Addin
                        

                    

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


                            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 235 12/11/2025
1.8.0 921 11/13/2025
1.8.0-b211.72089fd9 241 11/12/2025
1.7.4 585 8/6/2025
1.7.3 126 8/2/2025
1.7.2 365 3/16/2025
1.7.1 826 12/12/2024
1.7.0 3,403 11/12/2024
1.6.6 814 11/8/2024
1.6.5 672 8/31/2024
1.6.4 593 8/2/2024
1.6.3 1,905 5/15/2024
1.6.2 529 2/16/2024
1.6.1 4,396 1/5/2024
1.6.0 332 11/30/2023
1.5.10-b186.aca976b4 139 11/30/2023
1.5.9 268 11/29/2023
1.5.9-b174.64153841 138 11/23/2023
1.5.9-b172.dfc6e7bd 110 11/17/2023
1.5.9-b171.4e2b92e2 145 11/4/2023
1.5.8 19,402 10/23/2023
1.5.7 8,050 7/31/2023
1.5.6 13,853 7/13/2023
1.5.5 367 6/29/2023
1.5.4 1,228 3/7/2023
1.5.3 457 3/3/2023
1.5.2 1,020 1/11/2023
1.5.2-b92.7c961f5f 261 1/11/2023
1.5.0 766 11/9/2022
1.5.0-b88.7a7c20cd 238 11/9/2022
1.4.7 5,380 10/20/2022
1.4.6 1,007 10/17/2022
1.4.5 968 10/1/2022
1.4.4 961 8/16/2022
1.4.3 876 8/2/2022
1.4.2 921 7/19/2022
1.4.2-b80.7fdbfd04 269 7/19/2022
1.4.2-b74.acaf86f5 245 6/15/2022
1.4.1 1,238 6/13/2022
1.4.0 972 6/6/2022
1.3.8 2,830 4/12/2022
1.3.7 906 3/21/2022
1.3.6 874 3/17/2022
1.3.6-b67.ca5053f3 277 3/16/2022
1.3.6-b66.4a9683e6 271 3/16/2022
1.3.5 953 2/23/2022
1.3.4 1,164 1/20/2022
1.3.3 949 12/29/2021
1.3.2 808 12/11/2021
1.3.1 690 11/12/2021
1.3.0 680 11/8/2021
1.2.3 1,887 9/22/2021
1.2.2 973 8/20/2021
1.2.1 859 8/5/2021
1.2.0 2,372 8/1/2021
1.2.0-b37.a54030b9 342 6/24/2021
1.1.6 6,592 3/22/2021
1.1.5 1,915 3/9/2021
1.1.4 3,024 2/27/2021
1.1.3 1,565 2/17/2021
1.1.2 1,511 2/12/2021
1.1.1 1,828 2/1/2021
1.1.0 1,610 12/16/2020
1.1.0-b27.b66c309b 444 11/15/2020
1.0.12 3,914 10/18/2020
1.0.11 1,655 10/6/2020
1.0.10 1,673 9/30/2020
1.0.9 1,743 9/29/2020
1.0.8 1,770 9/26/2020
1.0.7 1,759 9/19/2020
1.0.6 1,694 9/3/2020
1.0.5 1,859 9/2/2020
1.0.4 2,013 9/1/2020
1.0.3 1,622 9/1/2020
1.0.2 1,625 8/29/2020
1.0.1 1,677 8/29/2020
1.0.0 1,711 8/29/2020
1.0.0-b1.c22f563d 427 8/28/2020

net10.0 support