DevOp.Toon.API
0.1.4
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package DevOp.Toon.API --version 0.1.4
NuGet\Install-Package DevOp.Toon.API -Version 0.1.4
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="DevOp.Toon.API" Version="0.1.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DevOp.Toon.API" Version="0.1.4" />
<PackageReference Include="DevOp.Toon.API" />
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 DevOp.Toon.API --version 0.1.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DevOp.Toon.API, 0.1.4"
#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 DevOp.Toon.API@0.1.4
#: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=DevOp.Toon.API&version=0.1.4
#tool nuget:?package=DevOp.Toon.API&version=0.1.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
DevOp.Toon.API
DevOp.Toon.API adds ASP.NET Core MVC formatter support for TOON.
Installation
dotnet add package DevOp.Toon.API
Features
- Registers TOON MVC formatters with
AddToon(...) - Supports
text/toonandapplication/toon - Reuses
DevOp.Toonfor TOON encoding, decoding, and options - Allows per-request response encode overrides through
X-Toon-Option-*headers
Basic Usage
using DevOp.Toon.API;
var builder = WebApplication.CreateBuilder(args);
builder.Services
.AddControllers()
.AddToon(useAsDefaultFormatter: false);
Per-Request Response Encode Overrides
Callers can override response encoding behavior for a single request by sending request headers in the format X-Toon-Option-<OptionName>: <value>.
Example:
GET /products
Accept: application/toon
X-Toon-Option-IgnoreNullOrEmpty: true
X-Toon-Option-ExcludeEmptyArrays: true
X-Toon-Option-ObjectArrayLayout: Columnar
X-Toon-Option-KeyFolding: off
X-Toon-Option-Delimiter: COMMA
This overlay is applied only for the current response and does not change the application's registered ToonServiceOptions.
See Documentation/PerRequestEncodeOptions.md for details.
Package Notes
DevOp.Toon.API depends on DevOp.Toon for the runtime TOON implementation.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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. 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.
-
net10.0
- DevOp.Toon (>= 0.2.4)
-
net8.0
- DevOp.Toon (>= 0.2.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Inital Stable Release