AvroSchemaGenerator 2.7.0

.NET 5.0 .NET Standard 2.0 
Install-Package AvroSchemaGenerator -Version 2.7.0
dotnet add package AvroSchemaGenerator --version 2.7.0
<PackageReference Include="AvroSchemaGenerator" Version="2.7.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add AvroSchemaGenerator --version 2.7.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support. 
#r "nuget: AvroSchemaGenerator, 2.7.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package. 
// Install AvroSchemaGenerator as a Cake Addin
#addin nuget:?package=AvroSchemaGenerator&version=2.7.0

// Install AvroSchemaGenerator as a Cake Tool
#tool nuget:?package=AvroSchemaGenerator&version=2.7.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

AvroSchemaGenerator

Use to generate Avro Schema with support for RECURSIVE SCHEMA

Getting Started

Install the NuGet package AvroSchemaGenerator and copy/paste the code below

using AvroSchemaGenerator;
public class Course
{
    public string Level { get; set; }
        
    public int Year { get; set; }
        
    public string State { get; set; }
        
    public string Gender { get; set; }
}
var avroSchema = typeof(Course).GetSchema();

By default, AvroSchemaGenerator generates schema with optional fields. The code below is an example of how to mark fields as required

using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using AvroSchemaGenerator;
public class Course
{
    [Required]
    public string Level { get; set; }

    [Required]
    public int Year { get; set; }

    [Required]
    public string State { get; set; }
        
    [Required]
    public string Gender { get; set; }
}
var avroSchema = typeof(Course).GetSchema();

You can assign a default value as well

using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using AvroSchemaGenerator;
public class Course
{
    [DefaultValue("200")]
    [Required]
    public string Level { get; set; }

    [Required]
    public int Year { get; set; }

    [DefaultValue("Closed")]
    public string State { get; set; }

    public string Gender { get; set; }
}
var avroSchema = typeof(Course).GetSchema();

Aliases

[Aliases("OldCourse")]
public class Course
{
    [Aliases("Level")]
    public string NewLevel { get; set; }
}

Logical Types

public class MessageTimeKind
{
    [LogicalType(LogicalTypeKind.TimeMicrosecond)]
    public TimeSpan TimeMicros { get; set; }

    [LogicalType(LogicalTypeKind.TimeMillisecond)]
    public TimeSpan TimeMillis { get; set; }
}
	
public class MessageTimestampKind
{
    [LogicalType(LogicalTypeKind.TimestampMicrosecond)]
    public DateTime StampMicros { get; set; }

    [LogicalType(LogicalTypeKind.TimestampMillisecond)]
    public DateTime StampMillis { get; set; }
}
	
public class MessageDateKind
{
    [LogicalType(LogicalTypeKind.Date)]
    public DateTime CreatedTime { get; set; }
        
    public AvroDecimal Size { get; set; }
        
	public string DayOfWeek { get; set; }
}

Custom Avro Definition

public class CustomDefinition
{
    [AvroSchema("{\n" +
                "  \"type\": \"bytes\",\n" +
                "  \"logicalType\": \"decimal\",\n" +
                "  \"precision\": 10,\n" +
                "  \"scale\": 6\n" +
                "}")]
    public AvroDecimal DecimalAvro { get; set; }
}

NOTE

  • Don't use same declaring type as dictionary value
  • Don't use same declaring type as list argument
  • Dictionary key must be a string type
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on AvroSchemaGenerator:

Package Downloads
Pulsar.Client

.NET client library for Apache Pulsar
SharpPulsar

SharpPulsar is Apache Pulsar Client built using Akka.net

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.7.0 299 7/20/2022
2.7.0-rc.139 34 7/20/2022
2.7.0-rc.138 38 7/20/2022
2.6.0 33,471 2/20/2022
2.6.0-rc.136 43 7/19/2022
2.5.2-alpha.2 74 1/16/2022
2.5.2-Alpha.1 68 1/16/2022
2.5.1 104 1/13/2022
2.5.0 209 12/26/2021
2.4.1 893 10/27/2021
2.4.0 15,911 9/28/2021
2.4.0-beta 126 9/28/2021
2.3.3 599 9/15/2021
2.3.3-beta 164 9/15/2021
2.3.2 151 9/15/2021
2.3.1-beta 143 9/15/2021
2.3.0 186 9/15/2021
2.2.0 409 9/13/2021
2.2.0-beta.17 100 9/13/2021
2.1.0 442 9/11/2021
2.1.0-beta.16 129 9/13/2021
2.1.0-beta.15 175 9/11/2021
2.0.0 438 9/10/2021
2.0.0-beta.14 116 9/9/2021
1.9.0 29,852 4/14/2021
1.9.0-beta.13 133 9/9/2021
1.9.0-beta.12 105 4/14/2021
1.9.0-beta.11 96 4/14/2021
1.9.0-beta.10 92 4/13/2021
1.9.0-beta.9 91 4/13/2021
1.9.0-beta.5 79 4/13/2021
1.9.0-beta.3 86 4/13/2021
1.9.0-beta.2 132 4/11/2021
1.8.0 61,273 12/10/2020
1.7.0 406 11/4/2020
1.6.0 35,208 6/26/2020
1.5.4 284 6/21/2020
1.5.3 3,200 5/27/2020
1.5.2 1,951 5/13/2020
1.5.1 700 5/13/2020
1.5.0 280 5/13/2020
1.4.1 313 5/11/2020
1.4.0 293 5/11/2020
1.3.0 889 4/30/2020
1.2.0 281 4/28/2020
1.1.0 498 4/27/2020
1.0.0 283 4/27/2020
0.1.2 934 4/14/2020
0.1.1 292 4/14/2020
0.1.0 762 4/11/2020

• Add Custom AVRO definition support @RobertIndie [https://github.com/eaba/AvroSchemaGenerator/commit/81272d5e24e63e152369c14b6c564333fc3aa9ac]

Full changelog at https://github.com/eaba/AvroSchemaGenerator/blob/main/CHANGELOG.md