JsonSerializerOptions.RespectRequiredConstructorParameters Property

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-rc.2.24473.5

Gets or sets a value that indicates whether non-optional constructor parameters should be specified during deserialization.

public:
 property bool RespectRequiredConstructorParameters { bool get(); void set(bool value); };

public bool RespectRequiredConstructorParameters { get; set; }

member this.RespectRequiredConstructorParameters : bool with get, set

Public Property RespectRequiredConstructorParameters As Boolean

Property Value

Boolean

Exceptions

InvalidOperationException

This property is set after serialization or deserialization has occurred.

Remarks

For historical reasons constructor-based deserialization treats all constructor parameters as optional by default, filling missing parameters with default values when they are not present in the JSON payload. This flag allows users to toggle that behavior as necessary for each JsonSerializerOptions instance. The default setting for this property can be toggled application-wide using the "System.Text.Json.Serialization.RespectRequiredConstructorParametersDefault" feature switch.

It is recommended that new applications always set this property to true, in combination with the closely related RespectNullableAnnotations property.