Soenneker.Blazor.ApiClient 4.0.3085

Prefix Reserved
.NET 10.0 This package targets .NET 10.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 Soenneker.Blazor.ApiClient --version 4.0.3085
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Soenneker.Blazor.ApiClient" />
                    


                            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 Soenneker.Blazor.ApiClient --version 4.0.3085
                    


                    

                
#r "nuget: Soenneker.Blazor.ApiClient, 4.0.3085"
#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 Soenneker.Blazor.ApiClient@4.0.3085
#: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=Soenneker.Blazor.ApiClient&version=4.0.3085
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Soenneker.Blazor.ApiClient&version=4.0.3085
                    


                            Install as a Cake Tool

alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image

Soenneker.Blazor.ApiClient

Defines methods for configuring and interacting with the API, including HTTP operations, authentication, and optional request/response logging.

Install

dotnet add package Soenneker.Blazor.ApiClient

Quick start

using Soenneker.Blazor.ApiClient.Registrars;
using Microsoft.Extensions.DependencyInjection;

var services = new ServiceCollection();
var result = services.AddApiClientAsScoped();

Adds IApiClient as a scoped service.

What you get

  • IApiClient — Defines methods for configuring and interacting with the API, including HTTP operations, authentication, and optional request/response logging.
  • ApiClientRegistrar — A lightweight and efficient API client wrapper for Blazor applications, simplifying HTTP communication with support for asynchronous calls, cancellation tokens, and JSON serialization.
  • RequestOptions — Represents the options for making an API request, including the URI, request payload, and logging settings.
  • RequestUploadOptions — Represents the options for uploading a file via an API request, extending RequestOptions with additional file upload properties.

API at a glance

API What it does Result / important behavior
IApiClient.Initialize(baseAddress, requestResponseLogging) Initializes the client with the specified base address and logging setting. Must be called before performing any HTTP operations. Returns no value; the requested change is complete when the method returns.
IApiClient.GetClient(allowAnonymous, cancellationToken) Retrieves or creates an HttpClient instance configured for authenticated or anonymous requests. A task that returns the configured HttpClient.
IApiClient.GetAccessToken(cancellationToken) Requests and returns a fresh access token using the configured authentication provider. A task that returns the access token string.
IApiClient.Get(uri, allowAnonymous, cancellationToken) Sends a GET request to the specified URI. A task that returns the HttpResponseMessage.
IApiClient.Get(options, cancellationToken) Sends a GET request using the specified RequestOptions. A task that returns the HttpResponseMessage.
IApiClient.Post(uri, obj, logResponse, allowAnonymous, cancellationToken) Sends a POST request with a JSON-serializable payload. A task that returns the HttpResponseMessage.
IApiClient.Post(options, cancellationToken) Sends a POST request using the specified RequestOptions. A task that returns the HttpResponseMessage.
IApiClient.Put(uri, obj, allowAnonymous, cancellationToken) Sends a PUT request with a JSON-serializable payload. A task that returns the HttpResponseMessage.
IApiClient.Put(options, cancellationToken) Sends a PUT request using the specified RequestOptions. A task that returns the HttpResponseMessage.
IApiClient.Delete(uri, cancellationToken) Sends a DELETE request to the specified URI. A task that returns the HttpResponseMessage.
IApiClient.Delete(options, cancellationToken) Sends a DELETE request using the specified RequestOptions. A task that returns the HttpResponseMessage.
IApiClient.Upload(options, cancellationToken) Uploads a file stream with optional JSON metadata. A task that returns the HttpResponseMessage.
ApiClientRegistrar.AddApiClientAsScoped(services) Adds IApiClient as a scoped service. The same service collection, so additional registrations can be chained.
RequestOptions.Uri Gets or sets the URI for the API request. Gets or sets the URI for the API request.
RequestOptions.Object Gets or sets an optional object that will be serialized and sent as the request body. Gets or sets an optional object that will be serialized and sent as the request body.
RequestOptions.AllowAnonymous Gets or sets a value indicating whether the request should allow anonymous access. Defaults to null (false). Gets or sets a value indicating whether the request should allow anonymous access. Defaults to null (false).
RequestOptions.LogResponse Gets or sets a value indicating whether the response should be logged. Defaults to null (false). Gets or sets a value indicating whether the response should be logged. Defaults to null (false).
RequestOptions.LogRequest Gets or sets a value indicating whether the request should be logged. Defaults to null (false). Gets or sets a value indicating whether the request should be logged. Defaults to null (false).

Important behavior

  • IApiClient.GetAccessToken(cancellationToken): Thrown if the user is not authenticated or if the token could not be acquired.

Practical notes

  • Cancellation stops pending work; it does not undo work that has already completed.
Product Compatible and additional computed target framework versions.
.NET 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 (2)

Showing the top 2 NuGet packages that depend on Soenneker.Blazor.ApiClient:

Package Downloads
Soenneker.Blazor.Consumer.Base

An abstract wrapper around Soenneker.Blazor.ApiClient supporting auto (de)serialization for requests/responses/ProblemDetails.
Soenneker.Blazor.Consumers.Core

A class that represents the core Blazor Consumer, providing no additional functionality than access to Soenneker.Blazor.ApiClient

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.0.3092 0 8/30/2026
4.0.3091 0 8/30/2026
4.0.3090 0 8/30/2026
4.0.3088 0 8/29/2026
4.0.3085 23 8/29/2026
4.0.3084 27 8/29/2026
4.0.3083 35 8/29/2026
4.0.3082 129 8/26/2026
4.0.3081 125 8/26/2026
4.0.3079 63 8/26/2026
4.0.3078 120 8/26/2026
4.0.3077 99 8/26/2026
4.0.3076 83 8/25/2026
4.0.3075 70 8/25/2026
4.0.3074 193 8/22/2026
4.0.3073 115 8/22/2026
4.0.3072 162 8/22/2026
4.0.3070 81 8/21/2026
4.0.3069 90 8/21/2026
Loading failed

Improve README usability and API guidance