How to use class fields with System.Text.Json.JsonSerializer?

by

In .NET Core 3.x, System.Text.Json does not serialize fields. From the docs:

Fields are not supported in System.Text.Json in .NET Core 3.1. Custom converters can provide this functionality.

In .NET 5 and later, public fields can be serialized by setting JsonSerializerOptions.IncludeFields to true or by marking the field to serialize with [JsonInclude]:

using System.Text.Json;

static void Main()
{
    var car = new Car { Model = "Fit", Year = 2008 };

    // Enable support
    var options = new JsonSerializerOptions { IncludeFields = true };

    // Pass "options"
    var json = JsonSerializer.Serialize(car, options);

    // Pass "options"
    var carDeserialized = JsonSerializer.Deserialize<Car>(json, options);

    Console.WriteLine(carDeserialized.Model); // Writes "Fit"
}

public class Car
{
    public int Year { get; set; }
    public string Model;
}

For details see:

More Related Contents:

  1. Converting newtonsoft code to System.Text.Json in .net core 3. what’s equivalent of JObject.Parse and JsonProperty
  2. Is polymorphic deserialization possible in System.Text.Json?
  3. System.Text.Json.JsonElement ToObject workaround
  4. System.Text.Json: How do I specify a custom name for an enum value?
  5. Parsing a JSON file with .NET core 3.0/System.text.Json
  6. System.Text.Json: Deserialize JSON with automatic casting
  7. Why does System.Text Json Serialiser not serialise this generic property but Json.NET does?
  8. Is there a built in way of using snake case as the naming policy for JSON in ASP.NET Core 3?
  9. Cannot deserialize the JSON array (e.g. [1,2,3]) into type ‘ ‘ because type requires JSON object (e.g. {“name”:”value”}) to deserialize correctly
  10. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  11. Line delimited json serializing and de-serializing
  12. How can I deserialize a child object with dynamic (numeric) key names?
  13. Setting the default JSON serializer in ASP.NET MVC
  14. Cannot deserialize the current JSON object (e.g. {“name”:”value”}) into type ‘System.Collections.Generic.List`1
  15. How to ignore JsonProperty(PropertyName = “someName”) when serializing json?
  16. Deserializing JSON when key values are unknown
  17. How to serialize/deserialize a custom collection with additional properties using Json.Net
  18. Serialize a container of enums as strings using JSON.net
  19. Handling decimal values in Newtonsoft.Json
  20. How to use default serialization in a custom System.Text.Json JsonConverter?
  21. JsonConvert.SerializeObject always return {} in XamarinForms
  22. How to convert Json array to list of objects in c#
  23. Custom json serialization for each item in IEnumerable [duplicate]
  24. How to return JSon object
  25. How to programmatically choose a constructor during deserialization?
  26. Is there a way to ignore get-only properties in Json.NET without using JsonIgnore attributes?
  27. Best ways to split a string with matching curly braces
  28. How to Ignoring Fields and Properties Conditionally During Serialization Using JSON.Net?
  29. Serialize only interface properties to JSON with Json.net
  30. Is there a way in Json.NET serialization to distinguish between “null because not present” and “null because null”?

Leave a Comment