PolymorphicContracts.TypeDiscriminatorSwaggerSetup 1.1.1

.NET 6.0 This package targets .NET 6.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 PolymorphicContracts.TypeDiscriminatorSwaggerSetup --version 1.1.1                

                    
                

            
NuGet\Install-Package PolymorphicContracts.TypeDiscriminatorSwaggerSetup -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="PolymorphicContracts.TypeDiscriminatorSwaggerSetup" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add PolymorphicContracts.TypeDiscriminatorSwaggerSetup --version 1.1.1                

                    
                

            
#r "nuget: PolymorphicContracts.TypeDiscriminatorSwaggerSetup, 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. 
// Install PolymorphicContracts.TypeDiscriminatorSwaggerSetup as a Cake Addin
#addin nuget:?package=PolymorphicContracts.TypeDiscriminatorSwaggerSetup&version=1.1.1

// Install PolymorphicContracts.TypeDiscriminatorSwaggerSetup as a Cake Tool
#tool nuget:?package=PolymorphicContracts.TypeDiscriminatorSwaggerSetup&version=1.1.1

Status:

NuGet

PolymorphicContracts.TypeDiscriminatorSwaggerSetup

Installation

NuGet

Install package : https://www.nuget.org/packages/PolymorphicContracts.TypeDiscriminatorSwaggerSetup.

GitHub

  • Clone locally this github repository
  • Build the PolymorphicContracts.TypeDiscriminatorSwaggerSetup.sln solution

Usage

Sample project example

In your ASP.NET Core 7 project choose assemblies, that contains hierarchies marked with JsonDerivedTypeAttribute.

List them in appsettings.json files as follows:

{
  //... your config
  "JsonHierarchies": {
    "Assemblies": [
      "PolymorphicContracts.Models"
    ]
  }
}

Then, while configuring services, after adding SwaggerGen call special extension:

builder.Services.AddTypeDiscriminatorToSwagger(builder.Configuration);

Rules for hierarchies

  1. Use same discriminator type. Whether it's all string, whether it's all int.
  2. Hierarchy root type must be abstract record or abstract class.
  3. Hierarchy must be "flat", i.e. you inherit only hierarchy root.

Wrong hierarchy example, breaking all rules:

[JsonDerivedType(typeof(DerivedFirst), typeDiscriminator: 1)]
[JsonDerivedType(typeof(DerivedSecond), typeDiscriminator: "2")]
interface IBase
{
}

record DerivedFirst : IBase;

record DerivedSecond : DerivedFirst;
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 360 6/8/2023
1.1.1 159 5/19/2023
1.1.0 158 5/12/2023
1.0.0 210 2/15/2023