Plinth.HttpApiClient 1.5.9-b172.dfc6e7bd

Prefix Reserved
This is a prerelease version of Plinth.HttpApiClient.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Plinth.HttpApiClient --version 1.5.9-b172.dfc6e7bd
                    
NuGet\Install-Package Plinth.HttpApiClient -Version 1.5.9-b172.dfc6e7bd
                    
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.5.9-b172.dfc6e7bd" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Plinth.HttpApiClient" Version="1.5.9-b172.dfc6e7bd" />
                    
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.5.9-b172.dfc6e7bd
                    
#r "nuget: Plinth.HttpApiClient, 1.5.9-b172.dfc6e7bd"
                    
#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.5.9-b172.dfc6e7bd
                    
#: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.5.9-b172.dfc6e7bd&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Plinth.HttpApiClient&version=1.5.9-b172.dfc6e7bd&prerelease
                    
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:net70',
        "/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 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 is compatible.  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.  net9.0 was computed.  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 was computed.  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.0 299 11/13/2025
1.8.0-b211.72089fd9 226 11/12/2025
1.7.4 485 8/6/2025
1.7.3 96 8/2/2025
1.7.2 331 3/16/2025
1.7.1 762 12/12/2024
1.7.0 2,212 11/12/2024
1.6.6 785 11/8/2024
1.6.5 634 8/31/2024
1.6.4 556 8/2/2024
1.6.3 1,872 5/15/2024
1.6.2 492 2/16/2024
1.6.1 4,239 1/5/2024
1.6.0 314 11/30/2023
1.5.10-b186.aca976b4 126 11/30/2023
1.5.9 243 11/29/2023
1.5.9-b174.64153841 124 11/23/2023
1.5.9-b172.dfc6e7bd 95 11/17/2023
1.5.9-b171.4e2b92e2 134 11/4/2023
1.5.8 16,593 10/23/2023
1.5.7 8,033 7/31/2023
1.5.6 13,812 7/13/2023
1.5.5 344 6/29/2023
1.5.4 1,206 3/7/2023
1.5.3 439 3/3/2023
1.5.2 996 1/11/2023
1.5.2-b92.7c961f5f 234 1/11/2023
1.5.0 742 11/9/2022
1.5.0-b88.7a7c20cd 217 11/9/2022
1.4.7 5,358 10/20/2022
1.4.6 982 10/17/2022
1.4.5 946 10/1/2022
1.4.4 940 8/16/2022
1.4.3 854 8/2/2022
1.4.2 901 7/19/2022
1.4.2-b80.7fdbfd04 243 7/19/2022
1.4.2-b74.acaf86f5 218 6/15/2022
1.4.1 1,207 6/13/2022
1.4.0 952 6/6/2022
1.3.8 2,806 4/12/2022
1.3.7 879 3/21/2022
1.3.6 849 3/17/2022
1.3.6-b67.ca5053f3 255 3/16/2022
1.3.6-b66.4a9683e6 250 3/16/2022
1.3.5 932 2/23/2022
1.3.4 1,140 1/20/2022
1.3.3 896 12/29/2021
1.3.2 784 12/11/2021
1.3.1 664 11/12/2021
1.3.0 656 11/8/2021
1.2.3 1,862 9/22/2021
1.2.2 953 8/20/2021
1.2.1 837 8/5/2021
1.2.0 2,339 8/1/2021
1.2.0-b37.a54030b9 322 6/24/2021
1.1.6 6,565 3/22/2021
1.1.5 1,894 3/9/2021
1.1.4 3,001 2/27/2021
1.1.3 1,539 2/17/2021
1.1.2 1,492 2/12/2021
1.1.1 1,807 2/1/2021
1.1.0 1,580 12/16/2020
1.1.0-b27.b66c309b 417 11/15/2020
1.0.12 3,869 10/18/2020
1.0.11 1,625 10/6/2020
1.0.10 1,649 9/30/2020
1.0.9 1,713 9/29/2020
1.0.8 1,742 9/26/2020
1.0.7 1,740 9/19/2020
1.0.6 1,669 9/3/2020
1.0.5 1,832 9/2/2020
1.0.4 1,990 9/1/2020
1.0.3 1,595 9/1/2020
1.0.2 1,604 8/29/2020
1.0.1 1,649 8/29/2020
1.0.0 1,688 8/29/2020
1.0.0-b1.c22f563d 401 8/28/2020

net7.0 support and removed netcoreapp3.1