YamlDotNet 16.2.1
YamlDotNet
Appveyor | NuGet |
---|---|
YamlDotNet is a YAML library for netstandard and other .NET runtimes.
YamlDotNet provides low level parsing and emitting of YAML as well as a high level object model similar to XmlDocument. A serialization library is also included that allows to read and write objects from and to YAML streams.
YamlDotNet's conformance with YAML specifications:
YAML Spec | YDN Parser | YDN Emitter |
---|---|---|
v1.1 | ✓ | ✓ |
v1.2 | ✓ |
What is YAML?
YAML, which stands for "YAML Ain't Markup Language", is described as "a human friendly data serialization standard for all programming languages". Like XML, it allows to represent about any kind of data in a portable, platform-independent format. Unlike XML, it is "human friendly", which means that it is easy for a human to read or produce a valid YAML document.
The YamlDotNet library
The library has now been successfully used in multiple projects and is considered fairly stable. It is compatible with the following runtimes:
- netstandard 2.0
- netstandard 2.1
- .NET 6.0
- .NET 8.0
- .NET Framework 4.7
Quick start
Here are some quick samples to get you started which can be viewed in this fiddle.
Serialization from an object to a string
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;
...
var person = new Person
{
Name = "Abe Lincoln",
Age = 25,
HeightInInches = 6f + 4f / 12f,
Addresses = new Dictionary<string, Address>{
{ "home", new Address() {
Street = "2720 Sundown Lane",
City = "Kentucketsville",
State = "Calousiyorkida",
Zip = "99978",
}},
{ "work", new Address() {
Street = "1600 Pennsylvania Avenue NW",
City = "Washington",
State = "District of Columbia",
Zip = "20500",
}},
}
};
var serializer = new SerializerBuilder()
.WithNamingConvention(CamelCaseNamingConvention.Instance)
.Build();
var yaml = serializer.Serialize(person);
System.Console.WriteLine(yaml);
// Output:
// name: Abe Lincoln
// age: 25
// heightInInches: 6.3333334922790527
// addresses:
// home:
// street: 2720 Sundown Lane
// city: Kentucketsville
// state: Calousiyorkida
// zip: 99978
// work:
// street: 1600 Pennsylvania Avenue NW
// city: Washington
// state: District of Columbia
// zip: 20500
Deserialization from a string to an object
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;
...
var yml = @"
name: George Washington
age: 89
height_in_inches: 5.75
addresses:
home:
street: 400 Mockingbird Lane
city: Louaryland
state: Hawidaho
zip: 99970
";
var deserializer = new DeserializerBuilder()
.WithNamingConvention(UnderscoredNamingConvention.Instance) // see height_in_inches in sample yml
.Build();
//yml contains a string containing your YAML
var p = deserializer.Deserialize<Person>(yml);
var h = p.Addresses["home"];
System.Console.WriteLine($"{p.Name} is {p.Age} years old and lives at {h.Street} in {h.City}, {h.State}.");
// Output:
// George Washington is 89 years old and lives at 400 Mockingbird Lane in Louaryland, Hawidaho.
More information
More information can be found in the project's wiki.
Installing
Just install the YamlDotNet NuGet package:
PM> Install-Package YamlDotNet
If you do not want to use NuGet, you can download binaries here.
YamlDotNet is also available on the Unity Asset Store.
Contributing
Please read CONTRIBUTING.md for guidelines.
Release notes
Please see the Releases at https://github.com/aaubry/YamlDotNet/releases
Sponsorships
A big shout out to all of our sponsors
Showing the top 20 packages that depend on YamlDotNet.
Packages | Downloads |
---|---|
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
32 |
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
30 |
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
29 |
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
28 |
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
27 |
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
|
26 |
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
26 |
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
25 |
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
24 |
KubernetesClient.Models
Client library for the Kubernetes open source container orchestrator.
|
23 |
.NET Framework 4.7
- No dependencies.
.NET 6.0
- No dependencies.
.NET 8.0
- No dependencies.
.NET Standard 2.0
- No dependencies.
.NET Standard 2.1
- No dependencies.
Version | Downloads | Last updated |
---|---|---|
16.2.1 | 3 | 12/03/2024 |
16.2.0 | 5 | 11/11/2024 |
16.1.3 | 10 | 09/27/2024 |
16.1.2 | 8 | 09/22/2024 |
16.1.1 | 7 | 09/21/2024 |
16.1.0 | 7 | 09/02/2024 |
16.0.0 | 13 | 07/20/2024 |
15.3.0 | 12 | 07/01/2024 |
15.1.6 | 16 | 06/05/2024 |
15.1.4 | 14 | 05/19/2024 |
15.1.2 | 18 | 03/03/2024 |
15.1.1 | 19 | 02/13/2024 |
15.1.0 | 17 | 02/05/2024 |
13.7.1 | 22 | 10/16/2023 |
13.7.0 | 21 | 10/16/2023 |
13.5.2 | 19 | 10/16/2023 |
13.5.1 | 19 | 10/14/2023 |
13.5.0 | 23 | 10/16/2023 |
13.4.0 | 20 | 10/02/2023 |
13.3.1 | 21 | 09/09/2023 |
13.2.0 | 20 | 08/23/2023 |
13.1.1 | 20 | 07/01/2023 |
13.1.0 | 26 | 07/05/2023 |
13.0.2 | 24 | 07/05/2023 |
13.0.1 | 23 | 07/13/2023 |
13.0.0 | 24 | 07/18/2023 |
12.3.1 | 21 | 07/04/2023 |
12.3.0 | 24 | 07/05/2023 |
12.2.1 | 21 | 07/31/2023 |
12.2.0 | 23 | 07/05/2023 |
12.1.0 | 23 | 08/01/2023 |
12.0.2 | 26 | 07/14/2023 |
12.0.1 | 22 | 07/05/2023 |
12.0.0 | 24 | 07/13/2023 |
11.2.1 | 17 | 07/12/2023 |
11.2.0 | 27 | 07/05/2023 |
11.1.3-nullable-enums-0003 | 21 | 07/17/2023 |
11.1.1 | 20 | 07/05/2023 |
11.1.0 | 21 | 08/19/2023 |
11.0.1 | 21 | 07/05/2023 |
10.1.0 | 23 | 07/14/2023 |
10.0.0 | 22 | 07/05/2023 |
9.1.4 | 22 | 07/06/2023 |
8.1.2 | 22 | 09/13/2023 |
8.1.0 | 22 | 08/09/2023 |
8.0.0 | 22 | 07/05/2023 |
7.0.0 | 25 | 08/01/2023 |
6.1.2 | 20 | 07/04/2023 |
6.1.1 | 23 | 07/06/2023 |
6.0.0 | 24 | 10/06/2023 |
5.4.0 | 21 | 07/17/2023 |
5.3.1 | 22 | 07/12/2023 |
5.3.0 | 20 | 07/17/2023 |
5.1.0 | 21 | 08/01/2023 |