System.Text.Json
8.0.0
Prefix Reserved
Advisory: https://github.com/advisories/GHSA-8g4q-xg66-9fp4 | Severity: high |
Advisory: https://github.com/advisories/GHSA-hh2w-p6rv-4g7w | Severity: high |
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
<PackageReference Include="System.Text.Json" Version="8.0.0" />
paket add System.Text.Json --version 8.0.0
#r "nuget: System.Text.Json, 8.0.0"
// 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
Related Packages
- Lightweight data formats abstraction: System.Memory.Data
- Serialization of HttpContent: System.Net.Http.Json
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 | Versions 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. |
-
.NETFramework 4.6.2
- Microsoft.Bcl.AsyncInterfaces (>= 8.0.0)
- System.Buffers (>= 4.5.1)
- System.Memory (>= 4.5.5)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Text.Encodings.Web (>= 8.0.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
- System.ValueTuple (>= 4.5.0)
-
.NETStandard 2.0
- Microsoft.Bcl.AsyncInterfaces (>= 8.0.0)
- System.Buffers (>= 4.5.1)
- System.Memory (>= 4.5.5)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Text.Encodings.Web (>= 8.0.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
net6.0
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Text.Encodings.Web (>= 8.0.0)
-
net7.0
- System.Text.Encodings.Web (>= 8.0.0)
-
net8.0
- System.Text.Encodings.Web (>= 8.0.0)
NuGet packages (7.1K)
Showing the top 5 NuGet packages that depend on System.Text.Json:
Package | Downloads |
---|---|
Microsoft.IdentityModel.Tokens
Includes types that provide support for SecurityTokens, Cryptographic operations: Signing, Verifying Signatures, Encryption. |
|
Microsoft.Extensions.DependencyModel
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. |
|
Azure.Core
This is the implementation of the Azure Client Pipeline |
|
Microsoft.Extensions.Configuration.Json
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. |
|
Microsoft.IdentityModel.Protocols.OpenIdConnect
Includes types that provide support for OpenIdConnect protocol. |
GitHub repositories (712)
Showing the top 5 popular GitHub repositories that depend on System.Text.Json:
Repository | Stars |
---|---|
microsoft/PowerToys
Windows system utilities to maximize productivity
|
|
jellyfin/jellyfin
The Free Software Media System
|
|
files-community/Files
A modern file manager that helps users organize their files and folders.
|
|
DevToys-app/DevToys
A Swiss Army knife for developers.
|
|
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
|
Version | Downloads | Last updated | |
---|---|---|---|
9.0.0-rc.2.24473.5 | 82,740 | 10/8/2024 | |
9.0.0-rc.1.24431.7 | 97,259 | 9/10/2024 | |
9.0.0-preview.7.24405.7 | 82,004 | 8/13/2024 | |
9.0.0-preview.6.24327.7 | 123,494 | 7/9/2024 | |
9.0.0-preview.5.24306.7 | 104,810 | 6/11/2024 | |
9.0.0-preview.4.24266.19 | 79,180 | 5/21/2024 | |
9.0.0-preview.3.24172.9 | 195,368 | 4/11/2024 | |
9.0.0-preview.2.24128.5 | 90,761 | 3/12/2024 | |
9.0.0-preview.1.24080.9 | 115,398 | 2/13/2024 | |
8.0.5 | 3,834,152 | 10/8/2024 | |
8.0.4 | 35,692,538 | 7/9/2024 | |
8.0.3 | 13,804,586 | 3/12/2024 | |
8.0.2 | 6,674,091 | 2/13/2024 | |
8.0.1 | 7,133,563 | 1/9/2024 | |
8.0.0 | 131,420,826 | 11/14/2023 | |
8.0.0-rc.2.23479.6 | 967,443 | 10/10/2023 | |
8.0.0-rc.1.23419.4 | 371,954 | 9/12/2023 | |
8.0.0-preview.7.23375.6 | 262,512 | 8/8/2023 | |
8.0.0-preview.6.23329.7 | 305,879 | 7/11/2023 | |
8.0.0-preview.5.23280.8 | 208,779 | 6/13/2023 | |
8.0.0-preview.4.23259.5 | 405,891 | 5/16/2023 | |
8.0.0-preview.3.23174.8 | 401,316 | 4/11/2023 | |
8.0.0-preview.2.23128.3 | 399,952 | 3/14/2023 | |
8.0.0-preview.1.23110.8 | 229,920 | 2/21/2023 | |
7.0.4 | 2,218,928 | 11/14/2023 | |
7.0.3 | 59,956,696 | 6/13/2023 | |
7.0.2 | 49,651,462 | 2/14/2023 | |
7.0.1 | 27,765,497 | 12/13/2022 | |
7.0.0 | 177,704,019 | 11/7/2022 | |
7.0.0-rc.2.22472.3 | 319,779 | 10/11/2022 | |
7.0.0-rc.1.22426.10 | 264,313 | 9/14/2022 | |
7.0.0-preview.7.22375.6 | 285,360 | 8/9/2022 | |
7.0.0-preview.6.22324.4 | 150,972 | 7/12/2022 | |
7.0.0-preview.5.22301.12 | 99,786 | 6/14/2022 | |
7.0.0-preview.4.22229.4 | 144,632 | 5/10/2022 | |
7.0.0-preview.3.22175.4 | 123,142 | 4/13/2022 | |
7.0.0-preview.2.22152.2 | 92,991 | 3/14/2022 | |
7.0.0-preview.1.22076.8 | 90,979 | 2/17/2022 | |
6.0.10 | 1,402,896 | 10/8/2024 | |
6.0.9 | 8,792,721 | 11/14/2023 | |
6.0.8 | 12,871,944 | 6/13/2023 | |
6.0.7 | 33,102,224 | 11/7/2022 | |
6.0.6 | 26,065,115 | 9/13/2022 | |
6.0.5 | 58,261,946 | 6/14/2022 | |
6.0.4 | 17,073,215 | 5/10/2022 | |
6.0.3 | 11,836,858 | 4/12/2022 | |
6.0.2 | 52,460,508 | 2/8/2022 | |
6.0.1 | 34,494,829 | 12/14/2021 | |
6.0.0 | 390,387,826 | 11/8/2021 | |
6.0.0-rc.2.21480.5 | 610,575 | 10/12/2021 | |
6.0.0-rc.1.21451.13 | 390,158 | 9/14/2021 | |
6.0.0-preview.7.21377.19 | 299,131 | 8/10/2021 | |
6.0.0-preview.6.21352.12 | 162,448 | 7/14/2021 | |
6.0.0-preview.5.21301.5 | 121,854 | 6/15/2021 | |
6.0.0-preview.4.21253.7 | 104,771 | 5/24/2021 | |
6.0.0-preview.3.21201.4 | 290,664 | 4/8/2021 | |
6.0.0-preview.2.21154.6 | 157,808 | 3/11/2021 | |
6.0.0-preview.1.21102.12 | 207,055 | 2/12/2021 | |
5.0.2 | 138,052,235 | 4/6/2021 | |
5.0.1 | 51,745,317 | 1/12/2021 | |
5.0.0 | 108,934,992 | 11/9/2020 | |
5.0.0-rc.2.20475.5 | 216,580 | 10/13/2020 | |
5.0.0-rc.1.20451.14 | 366,940 | 9/14/2020 | |
5.0.0-preview.8.20407.11 | 111,332 | 8/25/2020 | |
5.0.0-preview.7.20364.11 | 267,951 | 7/21/2020 | |
5.0.0-preview.6.20305.6 | 79,752 | 6/25/2020 | |
5.0.0-preview.5.20278.1 | 89,559 | 6/10/2020 | |
5.0.0-preview.4.20251.6 | 160,875 | 5/18/2020 | |
5.0.0-preview.3.20214.6 | 332,503 | 4/23/2020 | |
5.0.0-preview.2.20160.6 | 167,140 | 4/2/2020 | |
5.0.0-preview.1.20120.5 | 89,251 | 3/16/2020 | |
4.7.2 | 566,952,024 | 5/12/2020 | |
4.7.1 | 62,973,179 | 2/18/2020 | |
4.7.0 | 122,462,511 | 12/3/2019 | |
4.7.0-preview3.19551.4 | 316,363 | 11/13/2019 | |
4.7.0-preview2.19523.17 | 65,913 | 11/1/2019 | |
4.7.0-preview1.19504.10 | 92,760 | 10/15/2019 | |
4.6.0 | 541,491,512 | 9/23/2019 | |
4.6.0-rc1.19456.4 | 187,459 | 9/16/2019 | |
4.6.0-preview9.19421.4 | 531,454 | 9/4/2019 | |
4.6.0-preview9.19416.11 | 1,548 | 9/4/2019 | |
4.6.0-preview8.19405.3 | 186,372 | 8/13/2019 | |
4.6.0-preview7.19362.9 | 251,764 | 7/23/2019 | |
4.6.0-preview6.19303.8 | 247,033 | 6/12/2019 | |
4.6.0-preview6.19264.9 | 5,316 | 9/4/2019 | |
4.6.0-preview6.19259.10 | 26,209 | 5/10/2019 |