Table of Contents

Class CodeGeneratorSettings

Namespace
Refitter.Core
Assembly
Refitter.Core.dll

CSharp code generator settings

public class CodeGeneratorSettings
Inheritance
CodeGeneratorSettings
Inherited Members

Properties

AnyType

Gets or sets the any type (default: "object").

public string AnyType { get; set; }

Property Value

string

ArrayBaseType

Gets or sets the generic array .NET type which is used as base class (default: 'Collection').

public string ArrayBaseType { get; set; }

Property Value

string

ArrayInstanceType

Gets or sets the generic array .NET type which is used for ArrayType instances (default: 'Collection').

public string ArrayInstanceType { get; set; }

Property Value

string

ArrayType

Gets or sets the generic array .NET type (default: 'ICollection').

public string ArrayType { get; set; }

Property Value

string

DateTimeType

Gets or sets the date time .NET type (default: 'DateTimeOffset').

public string DateTimeType { get; set; }

Property Value

string

DateType

Gets or sets the date .NET type (default: 'DateTimeOffset').

public string DateType { get; set; }

Property Value

string

DictionaryBaseType

Gets or sets the generic dictionary .NET type which is used as base class (default: 'Dictionary').

public string DictionaryBaseType { get; set; }

Property Value

string

DictionaryInstanceType

Gets or sets the generic dictionary .NET type which is used for DictionaryType instances (default: 'Dictionary').

public string DictionaryInstanceType { get; set; }

Property Value

string

DictionaryType

Gets or sets the generic dictionary .NET type (default: 'IDictionary').

public string DictionaryType { get; set; }

Property Value

string

EnforceFlagEnums

Gets or sets a value indicating whether enums should be always generated as bit flags (default: false).

public bool EnforceFlagEnums { get; set; }

Property Value

bool

ExcludedTypeNames

Gets or sets the excluded type names (must be defined in an import or other namespace).

public string[] ExcludedTypeNames { get; set; }

Property Value

string[]

GenerateDataAnnotations

Gets or sets a value indicating whether to generated data annotation attributes (default: true).

public bool GenerateDataAnnotations { get; set; }

Property Value

bool

GenerateDefaultValues

Gets or sets a value indicating whether to generate default values for properties (when JSON Schema default is set, default: true).

public bool GenerateDefaultValues { get; set; }

Property Value

bool

GenerateImmutableArrayProperties

Gets or sets a value indicating whether to remove the setter for non-nullable array properties (default: false).

public bool GenerateImmutableArrayProperties { get; set; }

Property Value

bool

GenerateImmutableDictionaryProperties

Gets or sets a value indicating whether to remove the setter for non-nullable dictionary properties (default: false).

public bool GenerateImmutableDictionaryProperties { get; set; }

Property Value

bool

GenerateJsonMethods

Gets or sets a value indicating whether to render ToJson() and FromJson() methods (default: false).

public bool GenerateJsonMethods { get; set; }

Property Value

bool

GenerateNativeRecords

Generate C# 9.0 record types instead of record-like classes.

public bool GenerateNativeRecords { get; set; }

Property Value

bool

GenerateNullableReferenceTypes

Gets or sets a value indicating whether to generate Nullable Reference Type annotations (default: false).

public bool GenerateNullableReferenceTypes { get; set; }

Property Value

bool

GenerateOptionalPropertiesAsNullable

Gets or sets a value indicating whether optional schema properties (not required) are generated as nullable properties (default: false).

public bool GenerateOptionalPropertiesAsNullable { get; set; }

Property Value

bool

HandleReferences

Gets or sets a value indicating whether to use preserve references handling (All) in the JSON serializer (default: false).

public bool HandleReferences { get; set; }

Property Value

bool

InlineNamedAny

Gets or sets a value indicating whether named/referenced any schemas should be inlined or generated as class.

public bool InlineNamedAny { get; set; }

Property Value

bool

InlineNamedArrays

Gets or sets a value indicating whether named/referenced arrays should be inlined or generated as class with array inheritance.

public bool InlineNamedArrays { get; set; }

Property Value

bool

InlineNamedDictionaries

Gets or sets a value indicating whether named/referenced dictionaries should be inlined or generated as class with dictionary inheritance.

public bool InlineNamedDictionaries { get; set; }

Property Value

bool

InlineNamedTuples

Gets or sets a value indicating whether named/referenced tuples should be inlined or generated as class with tuple inheritance.

public bool InlineNamedTuples { get; set; }

Property Value

bool

JsonConverters

Gets or sets the custom Json.NET converters (class names) which are registered for serialization and deserialization.

public string[]? JsonConverters { get; set; }

Property Value

string[]

JsonSerializerSettingsTransformationMethod

Gets or sets the name of a static method which is called to transform the JsonSerializerSettings (for Newtonsoft.Json) or the JsonSerializerOptions (for System.Text.Json) used in the generated ToJson()/FromJson() methods (default: null).

public string? JsonSerializerSettingsTransformationMethod { get; set; }

Property Value

string

PropertyNameGenerator

Gets or sets a custom NJsonSchema.CodeGeneration.IPropertyNameGenerator.

[JsonIgnore]
public IPropertyNameGenerator? PropertyNameGenerator { get; set; }

Property Value

IPropertyNameGenerator

PropertySetterAccessModifier

Gets the access modifier of property setters (default: '').

public string PropertySetterAccessModifier { get; set; }

Property Value

string

RequiredPropertiesMustBeDefined

Gets or sets a value indicating whether a required property must be defined in JSON (sets Required.Always when the property is required) (default: true).

public bool RequiredPropertiesMustBeDefined { get; set; }

Property Value

bool

TimeSpanType

Gets or sets the time span .NET type (default: 'TimeSpan').

public string TimeSpanType { get; set; }

Property Value

string

TimeType

Gets or sets the time .NET type (default: 'TimeSpan').

public string TimeType { get; set; }

Property Value

string