System.Text.Json 8.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package System.Text.Json --version 8.0.0
NuGet\Install-Package System.Text.Json -Version 8.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="System.Text.Json" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add System.Text.Json --version 8.0.0
#r "nuget: System.Text.Json, 8.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install System.Text.Json as a Cake Addin
#addin nuget:?package=System.Text.Json&version=8.0.0

// Install System.Text.Json as a Cake Tool
#tool nuget:?package=System.Text.Json&version=8.0.0

About

Provides high-performance and low-allocating types that serialize objects to JavaScript Object Notation (JSON) text and deserialize JSON text to objects, with UTF-8 support built-in. Also provides types to read and write JSON text encoded as UTF-8, and to create an in-memory document object model (DOM), that is read-only, for random access of the JSON elements within a structured view of the data.

Key Features

  • High-performance reader and writer types for UTF-8 encoded JSON.
  • A fully-featured JSON serializer for .NET types using reflection or source generated contracts.
  • A high-performance read-only JSON DOM (JsonDocument) and a mutable DOM that interoperates with the serializer (JsonNode).
  • Built-in support for async serialization, including IAsyncEnumerable support.
  • Fully customizable contract model for serializable types.

How to Use

The System.Text.Json library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use the most recent version in older target frameworks.

Serialization:

using System;
using System.Text.Json;

WeatherForecast forecast = new (DateTimeOffset.Now, 26.6f, "Sunny");
var serialized = JsonSerializer.Serialize(forecast);

Console.WriteLine(serialized);
// {"Date":"2023-08-02T16:01:20.9025406+00:00","TemperatureCelsius":26.6,"Summary":"Sunny"}

var forecastDeserialized = JsonSerializer.Deserialize<WeatherForecast>(serialized);
Console.WriteLine(forecast == forecastDeserialized);
// True

public record WeatherForecast(DateTimeOffset Date, float TemperatureCelsius, string? Summary);

Serialization using the source generator:

using System.Text.Json;
using System.Text.Json.Serialization;

WeatherForecast forecast = new (DateTimeOffset.Now, 26.6f, "Sunny");
var serialized = JsonSerializer.Serialize(forecast, SourceGenerationContext.Default.WeatherForecast);

Console.WriteLine(serialized);
// {"Date":"2023-08-02T16:01:20.9025406+00:00","TemperatureCelsius":26.6,"Summary":"Sunny"}

var forecastDeserialized = JsonSerializer.Deserialize<WeatherForecast>(serialized, SourceGenerationContext.Default.WeatherForecast);
Console.WriteLine(forecast == forecastDeserialized);
// True

public record WeatherForecast(DateTimeOffset Date, float TemperatureCelsius, string? Summary);

[JsonSourceGenerationOptions(WriteIndented = true)]
[JsonSerializable(typeof(WeatherForecast))]
internal partial class SourceGenerationContext : JsonSerializerContext
{
}

Using the JSON DOM:


using System;
using System.Text.Json;
using System.Text.Json.Nodes;

string jsonString =
@"{
  ""Date"": ""2019-08-01T00:00:00"",
  ""Temperature"": 25,
  ""Summary"": ""Hot"",
  ""DatesAvailable"": [
    ""2019-08-01T00:00:00"",
    ""2019-08-02T00:00:00""
  ],
  ""TemperatureRanges"": {
      ""Cold"": {
          ""High"": 20,
          ""Low"": -10
      },
      ""Hot"": {
          ""High"": 60,
          ""Low"": 20
      }
  }
}
";

JsonNode forecastNode = JsonNode.Parse(jsonString)!;


// Get value from a JsonNode.
JsonNode temperatureNode = forecastNode["Temperature"]!;
Console.WriteLine($"Type={temperatureNode.GetType()}");
Console.WriteLine($"JSON={temperatureNode.ToJsonString()}");
//output:
//Type = System.Text.Json.Nodes.JsonValue`1[System.Text.Json.JsonElement]
//JSON = 25

// Get a typed value from a JsonNode.
int temperatureInt = (int)forecastNode["Temperature"]!;
Console.WriteLine($"Value={temperatureInt}");
//output:
//Value=25

// Get a typed value from a JsonNode by using GetValue<T>.
temperatureInt = forecastNode["Temperature"]!.GetValue<int>();
Console.WriteLine($"TemperatureInt={temperatureInt}");
//output:
//Value=25

// Get a JSON object from a JsonNode.
JsonNode temperatureRanges = forecastNode["TemperatureRanges"]!;
Console.WriteLine($"Type={temperatureRanges.GetType()}");
Console.WriteLine($"JSON={temperatureRanges.ToJsonString()}");
//output:
//Type = System.Text.Json.Nodes.JsonObject
//JSON = { "Cold":{ "High":20,"Low":-10},"Hot":{ "High":60,"Low":20} }

// Get a JSON array from a JsonNode.
JsonNode datesAvailable = forecastNode["DatesAvailable"]!;
Console.WriteLine($"Type={datesAvailable.GetType()}");
Console.WriteLine($"JSON={datesAvailable.ToJsonString()}");
//output:
//datesAvailable Type = System.Text.Json.Nodes.JsonArray
//datesAvailable JSON =["2019-08-01T00:00:00", "2019-08-02T00:00:00"]

// Get an array element value from a JsonArray.
JsonNode firstDateAvailable = datesAvailable[0]!;
Console.WriteLine($"Type={firstDateAvailable.GetType()}");
Console.WriteLine($"JSON={firstDateAvailable.ToJsonString()}");
//output:
//Type = System.Text.Json.Nodes.JsonValue`1[System.Text.Json.JsonElement]
//JSON = "2019-08-01T00:00:00"

// Get a typed value by chaining references.
int coldHighTemperature = (int)forecastNode["TemperatureRanges"]!["Cold"]!["High"]!;
Console.WriteLine($"TemperatureRanges.Cold.High={coldHighTemperature}");
//output:
//TemperatureRanges.Cold.High = 20

// Parse a JSON array
JsonNode datesNode = JsonNode.Parse(@"[""2019-08-01T00:00:00"",""2019-08-02T00:00:00""]")!;
JsonNode firstDate = datesNode[0]!.GetValue<DateTime>();
Console.WriteLine($"firstDate={ firstDate}");
//output:
//firstDate = "2019-08-01T00:00:00"

Using the low-level JSON reader/writer types

using System;
using System.IO;
using System.Text;
using System.Text.Json;

var writerOptions = new JsonWriterOptions
{
    Indented = true
};

using var stream = new MemoryStream();
using var writer = new Utf8JsonWriter(stream, writerOptions);

writer.WriteStartObject();
writer.WriteString("date", DateTimeOffset.Parse("8/2/2023 9:00 AM"));
writer.WriteNumber("temp", 42);
writer.WriteEndObject();
writer.Flush();

var jsonBytes = stream.ToArray();
string json = Encoding.UTF8.GetString(jsonBytes);
Console.WriteLine(json);
// {
//   "date": "2023-08-02T09:00:00+00:00"
//   "temp": 42
// }

var readerOptions = new JsonReaderOptions
{
    AllowTrailingCommas = true,
    CommentHandling = JsonCommentHandling.Skip
};
var reader = new Utf8JsonReader(jsonBytes, readerOptions);

while (reader.Read())
{
    Console.Write(reader.TokenType);

    switch (reader.TokenType)
    {
        case JsonTokenType.PropertyName:
        case JsonTokenType.String:
            {
                string? text = reader.GetString();
                Console.Write(" ");
                Console.Write(text);
                break;
            }

        case JsonTokenType.Number:
            {
                int intValue = reader.GetInt32();
                Console.Write(" ");
                Console.Write(intValue);
                break;
            }

            // Other token types elided for brevity
    }
    Console.WriteLine();
}
// StartObject
// PropertyName date
// String 2023-08-02T09:00:00+00:00
// PropertyName temp
// Number 42
// EndObject

Main Types

The main types provided by this library are:

  • System.Text.Json.Utf8JsonWriter
  • System.Text.Json.Utf8JsonReader
  • System.Text.Json.JsonSerializer
  • System.Text.Json.JsonConverter
  • System.Text.Json.JsonDocument
  • System.Text.Json.Nodes.JsonNode
  • System.Text.Json.Serialization.Metadata.JsonTypeInfo

Additional Documentation

Feedback & Contributing

System.Text.Json is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5.7K)

Showing the top 5 NuGet packages that depend on System.Text.Json:

Package Downloads
Microsoft.IdentityModel.Tokens The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Includes types that provide support for SecurityTokens, Cryptographic operations: Signing, Verifying Signatures, Encryption.

Microsoft.Extensions.DependencyModel The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides abstractions for reading `.deps` files. When a .NET application is compiled, the SDK generates a JSON manifest file (`<ApplicationName>.deps.json`) that contains information about application dependencies. You can use `Microsoft.Extensions.DependencyModel` to read information from this manifest at run time. This is useful when you want to dynamically compile code (for example, using Roslyn Emit API) referencing the same dependencies as your main application. By default, the dependency manifest contains information about the application's target framework and runtime dependencies. Set the PreserveCompilationContext project property to `true` to additionally include information about reference assemblies used during compilation.

Microsoft.IdentityModel.JsonWebTokens The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Includes types that provide support for creating, serializing and validating JSON Web Tokens. This is a newer, faster version of System.IdentityModel.Tokens.Jwt that has additional functionality.

Microsoft.Extensions.Configuration.Json The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

JSON configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read your application's settings from a JSON file. You can use JsonConfigurationExtensions.AddJsonFile extension method on IConfigurationBuilder to add the JSON configuration provider to the configuration builder.

Azure.Core The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This is the implementation of the Azure Client Pipeline

GitHub repositories (579)

Showing the top 5 popular GitHub repositories that depend on System.Text.Json:

Repository Stars
jellyfin/jellyfin
The Free Software Media System
dotnet/roslyn
The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
dotnet/runtime
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
dotnet/efcore
EF Core is a modern object-database mapper for .NET. It supports LINQ queries, change tracking, updates, and schema migrations.
Version Downloads Last updated
9.0.0-preview.1.24080.9 31,255 2/13/2024
8.0.2 421,915 2/13/2024
8.0.1 1,779,104 1/9/2024
8.0.0 19,806,356 11/14/2023
8.0.0-rc.2.23479.6 522,056 10/10/2023
8.0.0-rc.1.23419.4 259,432 9/12/2023
8.0.0-preview.7.23375.6 201,922 8/8/2023
8.0.0-preview.6.23329.7 250,866 7/11/2023
8.0.0-preview.5.23280.8 162,643 6/13/2023
8.0.0-preview.4.23259.5 232,855 5/16/2023
8.0.0-preview.3.23174.8 302,635 4/11/2023
8.0.0-preview.2.23128.3 268,135 3/14/2023
8.0.0-preview.1.23110.8 190,451 2/21/2023
7.0.4 740,938 11/14/2023
7.0.3 26,882,316 6/13/2023
7.0.2 28,573,514 2/14/2023
7.0.1 17,102,808 12/13/2022
7.0.0 122,727,392 11/7/2022
7.0.0-rc.2.22472.3 280,349 10/11/2022
7.0.0-rc.1.22426.10 223,329 9/14/2022
7.0.0-preview.7.22375.6 228,415 8/9/2022
7.0.0-preview.6.22324.4 125,911 7/12/2022
7.0.0-preview.5.22301.12 88,744 6/14/2022
7.0.0-preview.4.22229.4 124,561 5/10/2022
7.0.0-preview.3.22175.4 101,202 4/13/2022
7.0.0-preview.2.22152.2 79,597 3/14/2022
7.0.0-preview.1.22076.8 78,184 2/17/2022
6.0.9 1,045,741 11/14/2023
6.0.8 5,998,176 6/13/2023
6.0.7 21,974,440 11/7/2022
6.0.6 20,420,492 9/13/2022
6.0.5 45,426,777 6/14/2022
6.0.4 13,664,654 5/10/2022
6.0.3 8,916,772 4/12/2022
6.0.2 42,850,771 2/8/2022
6.0.2-mauipre.1.22102.15 70,130 2/15/2022
6.0.2-mauipre.1.22054.8 184,017 1/19/2022
6.0.1 25,550,893 12/14/2021
6.0.0 287,347,537 11/8/2021
6.0.0-rc.2.21480.5 571,112 10/12/2021
6.0.0-rc.1.21451.13 370,864 9/14/2021
6.0.0-preview.7.21377.19 284,663 8/10/2021
6.0.0-preview.6.21352.12 154,051 7/14/2021
6.0.0-preview.5.21301.5 115,533 6/15/2021
6.0.0-preview.4.21253.7 96,802 5/24/2021
6.0.0-preview.3.21201.4 272,187 4/8/2021
6.0.0-preview.2.21154.6 148,783 3/11/2021
6.0.0-preview.1.21102.12 192,905 2/12/2021
5.0.2 112,468,674 4/6/2021
5.0.1 44,282,359 1/12/2021
5.0.0 93,311,292 11/9/2020
5.0.0-rc.2.20475.5 201,351 10/13/2020
5.0.0-rc.1.20451.14 354,406 9/14/2020
5.0.0-preview.8.20407.11 105,266 8/25/2020
5.0.0-preview.7.20364.11 243,865 7/21/2020
5.0.0-preview.6.20305.6 76,398 6/25/2020
5.0.0-preview.5.20278.1 82,933 6/10/2020
5.0.0-preview.4.20251.6 154,296 5/18/2020
5.0.0-preview.3.20214.6 304,163 4/23/2020
5.0.0-preview.2.20160.6 161,929 4/2/2020
5.0.0-preview.1.20120.5 86,270 3/16/2020
4.7.2 392,131,654 5/12/2020
4.7.1 55,843,519 2/18/2020
4.7.0 104,324,384 12/3/2019
4.7.0-preview3.19551.4 306,412 11/13/2019
4.7.0-preview2.19523.17 61,895 11/1/2019
4.7.0-preview1.19504.10 89,802 10/15/2019
4.6.0 424,319,390 9/23/2019
4.6.0-rc1.19456.4 180,455 9/16/2019
4.6.0-preview9.19421.4 448,917 9/4/2019
4.6.0-preview9.19416.11 1,007 9/4/2019
4.6.0-preview8.19405.3 177,049 8/13/2019
4.6.0-preview7.19362.9 244,795 7/23/2019
4.6.0-preview6.19303.8 215,826 6/12/2019
4.6.0-preview6.19264.9 2,479 9/4/2019
4.6.0-preview6.19259.10 24,110 5/10/2019