Skip to content

JsonSchemaGeneratorSettings

Rico Suter edited this page Jun 13, 2019 · 26 revisions

Settings for the JsonSchemaGenerator.

Properties:

  • SerializerSettings

  • ExcludedTypeNames

  • IgnoreObsoleteProperties

  • GenerateEnumMappingDescription

  • DefaultReferenceTypeNullHandling

  • DefaultDictionaryValueReferenceTypeNullHandling

  • GenerateKnownTypes: Specifies whether to generate schemas for types in KnownTypeAttribute attributes.
  • FlattenInheritanceHierarchy: Value indicating whether to flatten the inheritance hierarchy instead of using allOf to describe inheritance (default: false).
  • GenerateAbstractProperties

  • GenerateXmlObjects

  • GenerateExamples

  • GenerateCustomNullableProperties

  • AlwaysAllowAdditionalObjectProperties

  • TypeMappers

  • SchemaProcessors

  • TypeNameGenerator

  • SchemaNameGenerator

  • ReflectionService

  • SchemaType (used in NSwag)

  • AllowReferencesWithProperties

Obsolete:

  • ContractResolver
  • DefaultEnumHandling: The default enum handling (default: Integer).
  • DefaultPropertyNameHandling: The default property name handling:
    • Default: Generates property name using reflection (respecting the JsonPropertyAttribute and DataMemberAttribute).
    • CamelCase: Generates lower camel cased property names using CamelCasePropertyNamesContractResolver.
Clone this wiki locally