Handle Yaml Files with .NET

 1title: Handle Yaml Files with .NET
 2description: This blog post shows a simple sample how to serialize and deserialize yaml files with .NET
 3
 4options:
 5    isDraft: true
 6    date: 2024-04-23T15:30:00Z
 7author:
 8    name: BEN ABT
 9    twitter: https://twitter.com/Abt_Benjamin
10    linkedIn: https://www.linkedin.com/in/benjaminabt/
11    job:
12        company: Medialesson GmbH
13        description: Chief PullRequest Officer
14        website: https://media-lesson.com/

 1public class BlogPost
 2{
 3    public string Title { get; set; } = null!;
 4    public string Description { get; set; } = null!;
 5    public Options Options { get; set; } = null!;
 6    public Author Author { get; set; } = null!;
 7    public string Content { get; set; } = null!;
 8}
 9public class Options
10{
11    public bool IsDraft { get; set; }
12    public DateTimeOffset Date { get; set; }
13}
14public class Author
15{
16    public string Name { get; set; } = null!;
17    public string Twitter { get; set; } = null!;
18    public string LinkedIn { get; set; } = null!;
19    public Job Job { get; set; } = null!;
20}
21public class Job
22{
23    public string Company { get; set; } = null!;
24    public string Description { get; set; } = null!;
25    public string Website { get; set; } = null!;
26}

1IDeserializer deserializer = new DeserializerBuilder()
2    .WithNamingConvention(CamelCaseNamingConvention.Instance)
3    .Build();
4
5// yamlBlogPost = string with yaml content
6BlogPost blogPost = deserializer.Deserialize<BlogPost>(yamlBlogPost); 

1ISerializer serializer = new SerializerBuilder()
2    .WithNamingConvention(CamelCaseNamingConvention.Instance)
3    .Build();
4
5string blogPostYaml = serializer.Serialize(blogPost);

 1// --------------------------------------------------------------------
 2// This sample shows the handling of YAML files in .NET.
 3// The YamlDotNet library (https://github.com/aaubry/YamlDotNet) is used to serialize and deserialize YAML files.
 4// 2024-04-23 - https://schwabencode.com
 5
 6// Runtime: .NET 8
 7// Sample Project: Console App
 8// Dependency: YamlDotNet
 9
10using YamlDotNet.Serialization;
11using YamlDotNet.Serialization.NamingConventions;
12
13// --------------------------------------------------------------------
14// sample Yaml-File in style of a blog post header
15string yamlBlogPost =
16    """
17    title: Handle Yaml Files with .NET
18    description: This blog post shows a simple sample how to serialize and deserialize yaml files with .NET
19
20    options:
21        isDraft: true
22        date: 2024-04-23T15:30:00Z
23    author:
24        name: BEN ABT
25        twitter: https://twitter.com/Abt_Benjamin
26        linkedIn: https://www.linkedin.com/in/benjaminabt/
27        job:
28            company: Medialesson GmbH
29            description: Chief PullRequest Officer
30            website: https://media-lesson.com/
31    """;
32    
33// --------------------------------------------------------------------
34// deserialize string as model
35IDeserializer deserializer = new DeserializerBuilder()
36    .WithNamingConvention(CamelCaseNamingConvention.Instance)
37    .Build();
38
39BlogPost blogPost = deserializer.Deserialize<BlogPost>(yamlBlogPost);
40
41// Print blog post
42Console.WriteLine(new string('-', 30));
43Console.WriteLine($"## Print Blog Post Object");
44Console.WriteLine($"Title: {blogPost.Title}");
45Console.WriteLine($"\tDescription: {blogPost.Description}");
46Console.WriteLine($"Options");
47Console.WriteLine($"\tIs Draft: {blogPost.Options.IsDraft}");
48Console.WriteLine($"\tDate: {blogPost.Options.Date:o}");
49Console.WriteLine($"Author");
50Console.WriteLine($"\tName: {blogPost.Author.Name}");
51Console.WriteLine($"\tTwitter: {blogPost.Author.Twitter}");
52Console.WriteLine($"\tLinkedIn: {blogPost.Author.LinkedIn}");
53Console.WriteLine($"\tJob");
54Console.WriteLine($"\t\tCompany: {blogPost.Author.Job.Company}");
55Console.WriteLine($"\t\tDescription: {blogPost.Author.Job.Description}");
56Console.WriteLine($"\t\tWebsite: {blogPost.Author.Job.Website}");
57
58// --------------------------------------------------------------------
59// create yaml serializer with options
60ISerializer serializer = new SerializerBuilder()
61    .WithNamingConvention(CamelCaseNamingConvention.Instance)
62    .Build();
63
64string blogPostYaml = serializer.Serialize(blogPost);
65
66Console.WriteLine(new string('-', 30));
67Console.WriteLine($"## Print Blog Post Text");
68Console.WriteLine(blogPostYaml);
69
70// --------------------------------------------------------------------
71// sample models as classes, records are not supported today
72public class BlogPost
73{
74    public string Title { get; set; } = null!;
75    public string Description { get; set; } = null!;
76    public Options Options { get; set; } = null!;
77    public Author Author { get; set; } = null!;
78    public string Content { get; set; } = null!;
79}
80public class Options
81{
82    public bool IsDraft { get; set; }
83    public DateTimeOffset Date { get; set; }
84}
85public class Author
86{
87    public string Name { get; set; } = null!;
88    public string Twitter { get; set; } = null!;
89    public string LinkedIn { get; set; } = null!;
90    public Job Job { get; set; } = null!;
91}
92public class Job
93{
94    public string Company { get; set; } = null!;
95    public string Description { get; set; } = null!;
96    public string Website { get; set; } = null!;
97}