YamlDotNet.System.Text.Json
1.7.1
.NET 8.0
This package targets .NET 8.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
dotnet add package YamlDotNet.System.Text.Json --version 1.7.1
NuGet\Install-Package YamlDotNet.System.Text.Json -Version 1.7.1
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="YamlDotNet.System.Text.Json" Version="1.7.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="YamlDotNet.System.Text.Json" Version="1.7.1" />
<PackageReference Include="YamlDotNet.System.Text.Json" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add YamlDotNet.System.Text.Json --version 1.7.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: YamlDotNet.System.Text.Json, 1.7.1"
#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.
#:package YamlDotNet.System.Text.Json@1.7.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=YamlDotNet.System.Text.Json&version=1.7.1
#tool nuget:?package=YamlDotNet.System.Text.Json&version=1.7.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
YamlDotNet.System.Text.Json
What is this?
This project contains components which allow YamlDotNet to handle System.Text.Json objects and serialize them to YAML and back.
Supported Objects:
- System.Text.Json.Nodes.JsonNode
- System.Text.Json.Nodes.JsonArray
- System.Text.Json.Nodes.JsonObject
- System.Text.Json.Nodes.JsonValue
- System.Text.Json.JsonElement
- System.Text.Json.JsonDocument
- System.Text.Json.Serialization.JsonIgnoreAttribute
- Conditions - condition that must be met before a property will be ignored
- Always = Ignore (Default)
- Never = Serialize
- WhenWritingNull = Serialize
- WhenWritingDefault = Serialize
- Conditions - condition that must be met before a property will be ignored
- System.Text.Json.Serialization.JsonPropertyNameAttribute
- Name - Specifies the property name that is present in the JSON/YAML when serializing and deserializing.
- System.Text.Json.Serialization.JsonPropertyOrderAttribute
- Order - Sets the serialization order of the property.
- System.Text.Json.Serialization.JsonStringEnumMemberNameAttribute
- Name - Sets the value for the Enum Member that is present in the JSON/YAML when serializing and deserializing.
- System.Text.Json.Serialization.JsonExtensionDataAttribute
Installation
dotnet add package YamlDotNet.System.Text.Json
YamlConverter
YamlConverter - exposes Serialize() and Deserialize<T>() methods
// to serialize a object to yaml
var yaml = YamlConverter.Serialize(someObject);
// to serialize json to yaml
var yaml = YamlConverter.SerializeJson(someJson);
// to load your object as a typed object
var obj = YamlConverter.Deserialize<MyTypedObject>(yaml);
How to integrate with YamlDotNet
Example:
using YamlDotNet.Serialization;
using YamlDotNet.System.Text.Json;
var serializer = new SerializerBuilder()
.AddSystemTextJson()
.Build();
var yaml = serializer.Serialize(obj);
var deserializer = new DeserializerBuilder()
.AddSystemTextJson()
.Build();
var myObject = deserializer.Deserialize<MyType>(yaml)
Inspired By
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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 was computed. 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.
-
.NETStandard 2.0
- System.Text.Json (>= 9.0.11)
- YamlDotNet (>= 16.3.0)
-
net10.0
- YamlDotNet (>= 16.3.0)
-
net8.0
- System.Text.Json (>= 9.0.11)
- YamlDotNet (>= 16.3.0)
-
net9.0
- YamlDotNet (>= 16.3.0)
NuGet packages (6)
Showing the top 5 NuGet packages that depend on YamlDotNet.System.Text.Json:
| Package | Downloads |
|---|---|
|
Devantler.KubernetesGenerator.Core
Package Description |
|
|
DevantlerTech.KubernetesGenerator.Core
Package Description |
|
|
MDAT
Markdown Auto-Tests for .net 6+, based on MSTestsV2 DataSource. |
|
|
CodeWF.Tools.Files
文件操作类集合 |
|
|
Cezanne.Core
Package Description |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on YamlDotNet.System.Text.Json:
| Repository | Stars |
|---|---|
|
Azure/apiops
APIOps applies the concepts of GitOps and DevOps to API deployment. By using practices from these two methodologies, APIOps can enable everyone involved in the lifecycle of API design, development, and deployment with self-service and automated tools to ensure the quality of the specifications and APIs that they’re building.
|
|
|
IvanJosipovic/KubeUI
Kubernetes User Interface
|
| Version | Downloads | Last Updated |
|---|---|---|
| 1.7.1 | 5,168 | 11/11/2025 |
| 1.7.0 | 1,014 | 11/10/2025 |
| 1.6.6 | 170,596 | 3/24/2025 |
| 1.6.5 | 27,679 | 12/23/2024 |
| 1.6.4 | 11,594 | 11/13/2024 |
| 1.6.3 | 768 | 11/11/2024 |
| 1.6.2 | 12,048 | 10/9/2024 |
| 1.6.1 | 1,630 | 9/26/2024 |
| 1.6.0 | 1,589 | 9/23/2024 |
| 1.5.1 | 3,553 | 9/23/2024 |
| 1.5.0 | 12,965 | 8/1/2024 |
| 1.4.2 | 19,410 | 7/9/2024 |
| 1.4.1 | 11,258 | 6/27/2024 |
| 1.4.0 | 11,648 | 4/13/2024 |
| 1.3.5 | 1,615 | 2/13/2024 |
| 1.3.4 | 7,390 | 11/15/2023 |
| 1.3.3 | 32,891 | 9/10/2023 |
| 1.3.2 | 424 | 8/28/2023 |
| 1.3.1 | 12,387 | 7/7/2023 |
| 1.3.0 | 2,607 | 4/26/2023 |
| 1.2.1 | 1,510 | 1/23/2023 |
| 1.2.0 | 10,631 | 9/12/2022 |
| 1.1.0 | 560 | 9/12/2022 |
| 1.0.0 | 923 | 8/15/2022 |