JsonDerivedTypeGenerator 0.2.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package JsonDerivedTypeGenerator --version 0.2.0

NuGet\Install-Package JsonDerivedTypeGenerator -Version 0.2.0

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="JsonDerivedTypeGenerator" Version="0.2.0" />

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

<PackageVersion Include="JsonDerivedTypeGenerator" Version="0.2.0" />
                    

                            Directory.Packages.props

<PackageReference Include="JsonDerivedTypeGenerator" />
                    

                            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 JsonDerivedTypeGenerator --version 0.2.0

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

#r "nuget: JsonDerivedTypeGenerator, 0.2.0"

#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 JsonDerivedTypeGenerator@0.2.0

#: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=JsonDerivedTypeGenerator&version=0.2.0
                    

                            Install as a Cake Addin

#tool nuget:?package=JsonDerivedTypeGenerator&version=0.2.0
                    

                            Install as a Cake Tool

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

JsonDerivedTypeGenerator

JsonDerivedTypeGenerator is a C# source generator that automatically adds [JsonDerivedType] attributes to base classes marked with [JsonPolymorphic], enabling correct polymorphic serialization with System.Text.Json.

The generator supports:

Only classes (for now!)
public and internal access modifier
abstract classes
deep inheritance

Unfortunately, the implementation of interfaces is not working at the moment.

Installation

You can add the generator to your project via NuGet:

  dotnet add package JsonDerivedTypeGenerator

The generator runs at compile time — you don’t need to invoke it manually.

Usage

Mark your base class as [JsonPolymorphic] and partial:

using System.Text.Json.Serialization;

[JsonPolymorphic]
public abstract partial class Animal
{
    public abstract void MakeNoise();
    public abstract string Kind { get; }
}

Without marking your base class as [JsonPolymorphic] and partial, it will not work.

Implement your base class:

public class Dog : Animal
{
    public override void MakeNoise() => {}
    public override string Kind => "Dog";
}

public class Cat : Animal
{
    public override void MakeNoise() => {}
    public override string Kind => "Cat";
}

When you build the project, the generator will automatically add [JsonDerivedType] attributes to the base class:

[JsonDerivedType(typeof(Dog), "Dog")]
[JsonDerivedType(typeof(Cat), "Cat")]
public abstract partial class Animal
{
    public abstract void MakeNoise();
    public abstract string Kind { get; }
}

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
- Microsoft.CodeAnalysis.CSharp (>= 4.3.0)
- Microsoft.CodeAnalysis.CSharp.Workspaces (>= 4.3.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.