Class JsonSchemaGenerator

Namespace

Newtonsoft.Json.Schema

Assembly

Newtonsoft.Json.dll

Generates a JsonSchema from a specified Type.

public class JsonSchemaGenerator

Inheritance

object

JsonSchemaGenerator

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

JsonSchemaGenerator()

public JsonSchemaGenerator()

Properties

ContractResolver

Gets or sets the contract resolver.

public IContractResolver ContractResolver { get; set; }

Property Value

IContractResolver

The contract resolver.

UndefinedSchemaIdHandling

Gets or sets how undefined schemas are handled by the serializer.

public UndefinedSchemaIdHandling UndefinedSchemaIdHandling { get; set; }

Property Value

UndefinedSchemaIdHandling

Methods

Generate(Type)

Generate a JsonSchema from the specified type.

public JsonSchema Generate(Type type)

Parameters

type Type

The type to generate a JsonSchema from.

Returns

JsonSchema

A JsonSchema generated from the specified type.

Generate(Type, JsonSchemaResolver)

Generate a JsonSchema from the specified type.

public JsonSchema Generate(Type type, JsonSchemaResolver resolver)

Parameters

type Type

The type to generate a JsonSchema from.

resolver JsonSchemaResolver

The JsonSchemaResolver used to resolve schema references.

Returns

JsonSchema

A JsonSchema generated from the specified type.

Generate(Type, JsonSchemaResolver, bool)

Generate a JsonSchema from the specified type.

public JsonSchema Generate(Type type, JsonSchemaResolver resolver, bool rootSchemaNullable)

Parameters

type Type

The type to generate a JsonSchema from.

resolver JsonSchemaResolver

The JsonSchemaResolver used to resolve schema references.

rootSchemaNullable bool

Specify whether the generated root JsonSchema will be nullable.

Returns

JsonSchema

A JsonSchema generated from the specified type.

Generate(Type, bool)

Generate a JsonSchema from the specified type.

public JsonSchema Generate(Type type, bool rootSchemaNullable)

Parameters

type Type

The type to generate a JsonSchema from.

rootSchemaNullable bool

Specify whether the generated root JsonSchema will be nullable.

Returns

JsonSchema

A JsonSchema generated from the specified type.