Plinth.HttpApiClient 1.5.10-b186.aca976b4

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
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.10-b186.aca976b4
                    


                    

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


                            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.10-b186.aca976b4
                    


                    

                
#r "nuget: Plinth.HttpApiClient, 1.5.10-b186.aca976b4"
#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.10-b186.aca976b4&prerelease
                    


                            Install Plinth.HttpApiClient as a Cake Addin
                        

                    

                
#tool nuget:?package=Plinth.HttpApiClient&version=1.5.10-b186.aca976b4&prerelease
                    


                            Install Plinth.HttpApiClient 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 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 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. 
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.2 184 a month ago
1.7.1 381 5 months ago
1.7.0 153 6 months ago
1.6.6 680 6 months ago
1.6.5 507 8 months ago
1.6.4 481 9 months ago
1.6.3 1,723 5/15/2024
1.6.2 394 2/16/2024
1.6.1 3,108 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 7,308 10/23/2023
1.5.7 7,123 7/31/2023
1.5.6 13,266 7/13/2023
1.5.5 261 6/29/2023
1.5.4 1,092 3/7/2023
1.5.3 338 3/3/2023
1.5.2 872 1/11/2023
1.5.2-b92.7c961f5f 141 1/11/2023
1.5.0 653 11/9/2022
1.5.0-b88.7a7c20cd 129 11/9/2022
1.4.7 5,214 10/20/2022
1.4.6 856 10/17/2022
1.4.5 838 10/1/2022
1.4.4 831 8/16/2022
1.4.3 734 8/2/2022
1.4.2 789 7/19/2022
1.4.2-b80.7fdbfd04 151 7/19/2022
1.4.2-b74.acaf86f5 141 6/15/2022
1.4.1 1,069 6/13/2022
1.4.0 818 6/6/2022
1.3.8 2,669 4/12/2022
1.3.7 761 3/21/2022
1.3.6 729 3/17/2022
1.3.6-b67.ca5053f3 159 3/16/2022
1.3.6-b66.4a9683e6 153 3/16/2022
1.3.5 805 2/23/2022
1.3.4 979 1/20/2022
1.3.3 737 12/29/2021
1.3.2 631 12/11/2021
1.3.1 539 11/12/2021
1.3.0 513 11/8/2021
1.2.3 1,714 9/22/2021
1.2.2 825 8/20/2021
1.2.1 683 8/5/2021
1.2.0 2,193 8/1/2021
1.2.0-b37.a54030b9 193 6/24/2021
1.1.6 6,346 3/22/2021
1.1.5 1,674 3/9/2021
1.1.4 2,779 2/27/2021
1.1.3 1,307 2/17/2021
1.1.2 1,299 2/12/2021
1.1.1 1,579 2/1/2021
1.1.0 1,352 12/16/2020
1.1.0-b27.b66c309b 318 11/15/2020
1.0.12 3,655 10/18/2020
1.0.11 1,385 10/6/2020
1.0.10 1,440 9/30/2020
1.0.9 1,498 9/29/2020
1.0.8 1,531 9/26/2020
1.0.7 1,497 9/19/2020
1.0.6 1,456 9/3/2020
1.0.5 1,605 9/2/2020
1.0.4 1,767 9/1/2020
1.0.3 1,383 9/1/2020
1.0.2 1,382 8/29/2020
1.0.1 1,428 8/29/2020
1.0.0 1,440 8/29/2020
1.0.0-b1.c22f563d 279 8/28/2020

net8.0 support