Namespace: Json.Schema.Serialization
Inheritance: ValidatingJsonConverter 🡒 JsonConverterFactory 🡒 JsonConverter 🡒 object
Adds schema validation for types decorated with the Json.Schema.Serialization.JsonSchemaAttribute.
Fields
| Name | Type | Summary |
|---|
| DefaultOptionsFactory | Func<JsonSerializerOptions, JsonSerializerOptions> | Default options factory used when creating validating converters. Creates a new JsonSerializerOptions without ValidatingJsonConverter instances to avoid recursion. |
Properties
| Name | Type | Summary |
|---|
| EvaluationOptions | EvaluationOptions | Provides evaluation options for the validator. |
| Type | Type | Â |
Methods
CanConvert(Type typeToConvert)
When overridden in a derived class, determines whether the converter instance can convert the specified object type.
Declaration
1
| public override bool CanConvert(Type typeToConvert)
|
| Parameter | Type | Description |
|---|
| typeToConvert | Type | The type of the object to check whether it can be converted by this converter instance. |
Returns
if the instance can convert the specified object type; otherwise, .
CreateConverter(Type typeToConvert, JsonSerializerOptions options)
Creates a converter for a specified type.
Declaration
1
| public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
|
| Parameter | Type | Description |
|---|
| typeToConvert | Type | The type handled by the converter. |
| options | JsonSerializerOptions | The serialization options to use. |
Returns
An instance of a System.Text.Json.Serialization.JsonConverter1** where T` is compatible with. If is returned, a **System.NotSupportedException will be thrown.
MapType(JsonSchema schema)
Adds an explicit type/schema mapping for types external types which cannot be decorated with Json.Schema.Serialization.JsonSchemaAttribute.
Declaration
1
| public static void MapType(JsonSchema schema)
|
| Parameter | Type | Description |
|---|
| schema | JsonSchema | Â |
RegisterConverter(Type type, JsonConverter converter)
Registers a pre-created converter for a specific type. Used primarily by source-generated code to register converters for AOT scenarios.
Declaration
1
| public static void RegisterConverter(Type type, JsonConverter converter)
|
| Parameter | Type | Description |
|---|
| type | Type | The type to register the converter for. |
| converter | JsonConverter | The converter instance to register. |
