Plinth.HttpApiClient 1.5.6

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package Plinth.HttpApiClient --version 1.5.6

NuGet\Install-Package Plinth.HttpApiClient -Version 1.5.6

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.6" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Plinth.HttpApiClient" Version="1.5.6" />
                    

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Plinth.HttpApiClient, 1.5.6"

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

#addin nuget:?package=Plinth.HttpApiClient&version=1.5.6
                    

                            Install Plinth.HttpApiClient as a Cake Addin

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

                            Install Plinth.HttpApiClient as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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 command, substituting the link to the swagger spec

	nswag openapi2csclient /runtime:net60 '/input:http://localhost:5000/swagger/v1/swagger.json' \
	    /classname:NSwagClient /namespace:My.Project.Client /output:NSwagClient.cs \
	    /operationGenerationMode:SingleClientFromOperationId /generateClientInterfaces:true \
	    /injectHttpClient:true /disposeHttpClient:false /useBaseUrl:false /generateOptionalParameters:true \
	    '/excludedParameterNames:X-Plinth-Auth'

Documentation for configuration options: https://github.com/RicoSuter/NSwag/wiki/NSwag-Configuration-Document

     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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Microsoft.Extensions.Configuration.Abstractions (>= 7.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 7.0.0)
- Microsoft.Extensions.Http (>= 7.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 7.0.0)
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- Plinth.Common (>= 1.5.6)
- Plinth.HttpApiClient.Common (>= 1.5.6)
- Plinth.Serialization (>= 1.5.6)
net7.0
- Microsoft.Extensions.Configuration.Abstractions (>= 7.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 7.0.0)
- Microsoft.Extensions.Http (>= 7.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 7.0.0)
- Microsoft.SourceLink.Bitbucket.Git (>= 1.1.1)
- Plinth.Common (>= 1.5.6)
- Plinth.HttpApiClient.Common (>= 1.5.6)
- Plinth.Serialization (>= 1.5.6)

NuGet packages (1)

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

Package	Downloads
Plinth.HttpApiClient.Polly Polly extensions for Plinth.HttpApiClient	42.1K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.7.2	155	3/16/2025
1.7.1	333	12/12/2024
1.7.0	147	11/12/2024
1.6.6	676	11/8/2024
1.6.5	498	8/31/2024
1.6.4	477	8/2/2024
1.6.3	1,611	5/15/2024
1.6.2	390	2/16/2024
1.6.1	3,010	1/5/2024
1.6.0	231	11/30/2023
1.5.10-b186.aca976b4	80	11/30/2023
1.5.9	179	11/29/2023
1.5.9-b174.64153841	85	11/23/2023
1.5.9-b172.dfc6e7bd	76	11/17/2023
1.5.9-b171.4e2b92e2	83	11/4/2023
1.5.8	6,590	10/23/2023
1.5.7	6,783	7/31/2023
1.5.6	13,170	7/13/2023
1.5.5	259	6/29/2023
1.5.4	1,089	3/7/2023
1.5.3	335	3/3/2023
1.5.2	869	1/11/2023
1.5.2-b92.7c961f5f	138	1/11/2023
1.5.0	650	11/9/2022
1.5.0-b88.7a7c20cd	124	11/9/2022
1.4.7	5,209	10/20/2022
1.4.6	853	10/17/2022
1.4.5	834	10/1/2022
1.4.4	828	8/16/2022
1.4.3	730	8/2/2022
1.4.2	785	7/19/2022
1.4.2-b80.7fdbfd04	147	7/19/2022
1.4.2-b74.acaf86f5	137	6/15/2022
1.4.1	1,063	6/13/2022
1.4.0	814	6/6/2022
1.3.8	2,665	4/12/2022
1.3.7	757	3/21/2022
1.3.6	725	3/17/2022
1.3.6-b67.ca5053f3	155	3/16/2022
1.3.6-b66.4a9683e6	149	3/16/2022
1.3.5	801	2/23/2022
1.3.4	974	1/20/2022
1.3.3	730	12/29/2021
1.3.2	626	12/11/2021
1.3.1	533	11/12/2021
1.3.0	507	11/8/2021
1.2.3	1,708	9/22/2021
1.2.2	819	8/20/2021
1.2.1	677	8/5/2021
1.2.0	2,187	8/1/2021
1.2.0-b37.a54030b9	187	6/24/2021
1.1.6	6,339	3/22/2021
1.1.5	1,667	3/9/2021
1.1.4	2,771	2/27/2021
1.1.3	1,299	2/17/2021
1.1.2	1,291	2/12/2021
1.1.1	1,571	2/1/2021
1.1.0	1,344	12/16/2020
1.1.0-b27.b66c309b	310	11/15/2020
1.0.12	3,573	10/18/2020
1.0.11	1,376	10/6/2020
1.0.10	1,432	9/30/2020
1.0.9	1,490	9/29/2020
1.0.8	1,523	9/26/2020
1.0.7	1,489	9/19/2020
1.0.6	1,448	9/3/2020
1.0.5	1,597	9/2/2020
1.0.4	1,759	9/1/2020
1.0.3	1,375	9/1/2020
1.0.2	1,374	8/29/2020
1.0.1	1,420	8/29/2020
1.0.0	1,432	8/29/2020
1.0.0-b1.c22f563d	271	8/28/2020

net7.0 support and removed netcoreapp3.1