DevOp.Toon.Client
0.2.0
dotnet add package DevOp.Toon.Client --version 0.2.0
NuGet\Install-Package DevOp.Toon.Client -Version 0.2.0
<PackageReference Include="DevOp.Toon.Client" Version="0.2.0" />
<PackageVersion Include="DevOp.Toon.Client" Version="0.2.0" />
<PackageReference Include="DevOp.Toon.Client" />
paket add DevOp.Toon.Client --version 0.2.0
#r "nuget: DevOp.Toon.Client, 0.2.0"
#:package DevOp.Toon.Client@0.2.0
#addin nuget:?package=DevOp.Toon.Client&version=0.2.0
#tool nuget:?package=DevOp.Toon.Client&version=0.2.0
DevOp.Toon.Client
A typed HttpClient integration for TOON request bodies and TOON/JSON responses. Targets .NET Standard 2.0, .NET 8, .NET 9, and .NET 10.
Version scope: this guide covers Client 0.2.0 with runtime 0.3.0 and Core 0.2.0.
dotnet add package DevOp.Toon.Client
using DevOp.Toon;
using DevOp.Toon.Client;
using DevOp.Toon.Core;
builder.Services.AddToonClient(options =>
{
options.BaseAddress = new Uri("https://api.example.com/");
options.Timeout = TimeSpan.FromSeconds(30);
options.EncodeOptions = new ToonEncodeOptions
{
ProtocolVersion = ToonProtocolVersion.V4_4
};
options.ResponseEncodeOverrides = new ToonResponseEncodeOverrideOptions
{
ProtocolVersion = ToonProtocolVersion.CustomV4_4,
Indent = 2,
IgnoreNullOrEmpty = false,
ExcludeEmptyArrays = false
};
});
Inject IToonClient and pass cancellation through each operation:
public sealed class CatalogSync(IToonClient client)
{
public Task<List<Product>?> GetProductsAsync(CancellationToken cancellationToken)
=> client.GetAsync<List<Product>>("api/products", cancellationToken);
}
Product is the application's response model.
Request and response versions
EncodeOptions.ProtocolVersionselects the outbound request body format. The client sends its concrete version inX-Toon-Version.ResponseEncodeOverrides.ProtocolVersionsendsX-Toon-Option-ProtocolVersion, asking a compatible server to select the response format. It does not change the outbound body.- A TOON response's
X-Toon-Versionsupplies the decode hint. Invalid, unsupported, multiple, or conflicting response hints produceToonClientException. An explicitDecodeOptions.ProtocolVersionmust agree with the header. - Without a response header, decoding uses the configured options, defaulting to
Auto. Ambiguous version-dependent data requires a concrete hint rather than a parse retry. ConfigureDecodeOptionsfor a known headerless legacy endpoint.
Supported concrete versions are V3_0, V4_0 through V4_4, CustomLegacy, and CustomV4_4. Auto is for decoding only. The transport names are 3.0, 4.0 through 4.4, custom-legacy, and custom-4.4.
Defaults and migration
Requests now default to official 4.4, one-space indentation, comma delimiters, key folding off, and both omission options false. Byte sequences default to Base64String. Select CustomLegacy for the previous custom wire profile, or CustomV4_4 for nested header groups plus row/keyed spills. Both custom profiles default IgnoreNullOrEmpty and ExcludeEmptyArrays to true; explicitly set both false for data-preserving output. Custom formats require compatible readers.
ResponseEncodeOverrides.Indent is now int? (a breaking change from bool?): set an integer width such as 2, or leave it null to send no indentation override. DevOp.Toon.API accepts HTTP indentation widths from 1 through 16; this input limit is separate from trusted direct runtime configuration. The API defaults to two spaces when no override is supplied.
ResponseEncodeOverrides controls only the headers sent to a compatible API. Other options cover response formatting, not local decoding. JSON responses use JsonSerializerOptions (web defaults). Automatic decompression is enabled by default for gzip/deflate, with Brotli on supported modern targets; set EnableCompression false to disable it.
Source: DevOp.Toon.Client repository. Use DevOp.Toon directly for serialization without HTTP.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 is compatible. 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 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. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- DevOp.Toon (>= 0.3.0)
- DevOp.Toon.Core (>= 0.2.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Http (>= 10.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
- System.Text.Json (>= 10.0.2)
-
net10.0
- DevOp.Toon (>= 0.3.0)
- DevOp.Toon.Core (>= 0.2.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Http (>= 10.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
-
net8.0
- DevOp.Toon (>= 0.3.0)
- DevOp.Toon.Core (>= 0.2.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Http (>= 10.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
- System.Text.Json (>= 10.0.2)
-
net9.0
- DevOp.Toon (>= 0.3.0)
- DevOp.Toon.Core (>= 0.2.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Http (>= 10.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
- System.Text.Json (>= 10.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Adds protocol-aware TOON HTTP requests and responses.
- Adds body-version metadata and enum-based response-version requests
- Adds response version validation and preserves hints for fallback and lazy error decoding
- Breaking: defaults outbound encoding to official 4.4; select CustomLegacy for previous wire behavior
- Breaking: changes the response Indent override from bool? to int? to transmit an integer width
- Improves response option reuse and UTF-8 validation without changing HTTP completion policy
- Updates runtime and contracts dependencies to DevOp.Toon 0.3.0 and DevOp.Toon.Core 0.2.0