Plinth.HttpApiClient 1.5.9-b171.4e2b92e2

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-b171.4e2b92e2
                    
NuGet\Install-Package Plinth.HttpApiClient -Version 1.5.9-b171.4e2b92e2
                    
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-b171.4e2b92e2" />
                    
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-b171.4e2b92e2" />
                    
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-b171.4e2b92e2
                    
#r "nuget: Plinth.HttpApiClient, 1.5.9-b171.4e2b92e2"
                    
#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-b171.4e2b92e2
                    
#: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-b171.4e2b92e2&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Plinth.HttpApiClient&version=1.5.9-b171.4e2b92e2&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.7.4 340 8/6/2025
1.7.3 52 8/2/2025
1.7.2 281 3/16/2025
1.7.1 617 12/12/2024
1.7.0 940 11/12/2024
1.6.6 746 11/8/2024
1.6.5 585 8/31/2024
1.6.4 532 8/2/2024
1.6.3 1,843 5/15/2024
1.6.2 461 2/16/2024
1.6.1 3,855 1/5/2024
1.6.0 278 11/30/2023
1.5.10-b186.aca976b4 104 11/30/2023
1.5.9 222 11/29/2023
1.5.9-b174.64153841 109 11/23/2023
1.5.9-b172.dfc6e7bd 88 11/17/2023
1.5.9-b171.4e2b92e2 116 11/4/2023
1.5.8 12,578 10/23/2023
1.5.7 7,999 7/31/2023
1.5.6 13,712 7/13/2023
1.5.5 319 6/29/2023
1.5.4 1,158 3/7/2023
1.5.3 404 3/3/2023
1.5.2 952 1/11/2023
1.5.2-b92.7c961f5f 201 1/11/2023
1.5.0 707 11/9/2022
1.5.0-b88.7a7c20cd 195 11/9/2022
1.4.7 5,306 10/20/2022
1.4.6 930 10/17/2022
1.4.5 907 10/1/2022
1.4.4 902 8/16/2022
1.4.3 804 8/2/2022
1.4.2 860 7/19/2022
1.4.2-b80.7fdbfd04 215 7/19/2022
1.4.2-b74.acaf86f5 194 6/15/2022
1.4.1 1,151 6/13/2022
1.4.0 907 6/6/2022
1.3.8 2,761 4/12/2022
1.3.7 839 3/21/2022
1.3.6 805 3/17/2022
1.3.6-b67.ca5053f3 227 3/16/2022
1.3.6-b66.4a9683e6 220 3/16/2022
1.3.5 890 2/23/2022
1.3.4 1,081 1/20/2022
1.3.3 835 12/29/2021
1.3.2 724 12/11/2021
1.3.1 620 11/12/2021
1.3.0 601 11/8/2021
1.2.3 1,806 9/22/2021
1.2.2 907 8/20/2021
1.2.1 775 8/5/2021
1.2.0 2,277 8/1/2021
1.2.0-b37.a54030b9 284 6/24/2021
1.1.6 6,470 3/22/2021
1.1.5 1,805 3/9/2021
1.1.4 2,899 2/27/2021
1.1.3 1,431 2/17/2021
1.1.2 1,417 2/12/2021
1.1.1 1,701 2/1/2021
1.1.0 1,481 12/16/2020
1.1.0-b27.b66c309b 383 11/15/2020
1.0.12 3,797 10/18/2020
1.0.11 1,509 10/6/2020
1.0.10 1,553 9/30/2020
1.0.9 1,618 9/29/2020
1.0.8 1,646 9/26/2020
1.0.7 1,634 9/19/2020
1.0.6 1,573 9/3/2020
1.0.5 1,740 9/2/2020
1.0.4 1,897 9/1/2020
1.0.3 1,508 9/1/2020
1.0.2 1,515 8/29/2020
1.0.1 1,540 8/29/2020
1.0.0 1,577 8/29/2020
1.0.0-b1.c22f563d 360 8/28/2020

net7.0 support and removed netcoreapp3.1