OneOf.Serialization.SystemTextJson 1.1.1

.NET Standard 2.0

dotnet add package OneOf.Serialization.SystemTextJson --version 1.1.1

NuGet\Install-Package OneOf.Serialization.SystemTextJson -Version 1.1.1

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="OneOf.Serialization.SystemTextJson" Version="1.1.1" />

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

<PackageVersion Include="OneOf.Serialization.SystemTextJson" Version="1.1.1" />
                    

                            Directory.Packages.props

<PackageReference Include="OneOf.Serialization.SystemTextJson" />
                    

                            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 OneOf.Serialization.SystemTextJson --version 1.1.1

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

#r "nuget: OneOf.Serialization.SystemTextJson, 1.1.1"

#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 OneOf.Serialization.SystemTextJson@1.1.1

#: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=OneOf.Serialization.SystemTextJson&version=1.1.1
                    

                            Install as a Cake Addin

#tool nuget:?package=OneOf.Serialization.SystemTextJson&version=1.1.1
                    

                            Install as a Cake Tool

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

JSON serialization

This library provides support for JSON serialization and deserialization of OneOf types using System.Text.Json.

Usage

Add a reference to OneOf.Serialization.SystemTextJson in your .csproj:

<ItemGroup>
    <PackageReference Include="OneOf.Serialization.SystemTextJson" Version="1.1.1"/>
</ItemGroup>

This provides access to two JsonConverter classes. Create a JsonSerializerOptions with both converters:

var serializerOptions = new JsonSerializerOptions
{
    Converters =
    {
        new OneOfJsonConverter(),
        new OneOfBaseJsonConverter(),
    },
};

(You can omit OneOfBaseJsonConverter if you are not serializing types derived from OneOfBase but not the other way around.)

Then serialize and deserialize using the serializerOptions:

var json = JsonSerializer.Serialize(oneOfToSerialize, serializerOptions);
var deserializeOneOf = JsonSerializer.Deserialize<OneOf<Foo, Bar, Baz>>(json, serializerOptions);

JSON format

In the case of an OneOf with types Foo, Bar and Baz that all serialize to JSON objects the generated JSON will be one of the following:

When Foo is the value:

{
    "Foo": {
        // ...
    }
}

When Bar is the value:

{
    "Bar": {
        // ...
    }
}

And when Baz is the value:

{
    "Baz": {
        // ...
    }
}

See project repository for more information.

Product	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 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. net10.0 was computed. 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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- OneOf (>= 3.0.263)
- System.Text.Json (>= 7.0.3)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on OneOf.Serialization.SystemTextJson:

Package	Downloads
Reliance.Titan.Core Package designed by Reliance Consultoria that provides support for handling cross-cutting concerns in our Microservices.	867

GitHub repositories

This package is not used by any popular GitHub repositories.