How to Generate JSON from JSON Schema File in .Net C#?

-

 Many a times we may have the JSON Schema file describing the JSON content type and its format. Our requirement may be to generate a JSON file from the Schema with the default values for the properties populated from the Schema file. Here we are going to see how this can be done using a simple static utility class in .Net.

Generating Default JSON from JSON Schema file

For this example I have created a Console Application in C# .Net Framework, and in the Program.cs file I have hardcoded the JSON Schema which acts as our input to generate the JSON.


  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Schema;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace JSONGeneratorFromSchema
{
    public static class JSONGenerator
    {
        public static JToken Generate(JSchema schema)
        {
            JToken token = null;
            switch (schema.Type)
            {
                case JSchemaType.None:
                    break;
                case JSchemaType.Object:
                    {
                        var jObj = new JObject();
                        if (schema.Properties != null)
                        {
                            foreach (var property in schema.Properties)
                            {
                                jObj.Add(Transform(property.Key), Generate(property.Value));
                            }
                        }
                        return jObj;
                    }
                    break;
                case JSchemaType.Array:
                    {
                        var array = new JArray();
                        foreach (var item in schema.Items)
                        {
                            array.Add(Generate(item));
                        }
                        return array;
                    }
                    break;
                case JSchemaType.Integer:
                    {
                        if(schema.Default != null)
                        {
                            var value = new JValue(int.Parse(schema.Default.ToString()));
                            return value;
                        }
                    }
                    break;
                case JSchemaType.Number:
                    {
                        if (schema.Default != null)
                        {
                            var value = new JValue(float.Parse(schema.Default.ToString()));
                            return value;
                        }
                    }
                    break;
                case JSchemaType.String:
                    if (schema.Default != null)
                    {
                        var value = new JValue(schema.Default.ToString());
                        return value;
                    }
                    break;
                case JSchemaType.Boolean:
                    if (schema.Default != null)
                    {
                        var value = new JValue(bool.Parse(schema.Default.ToString()));
                        return value;
                    }
                    break;
                case JSchemaType.Null:
                    return null;
                    break;
                default:
                    break;
            }

            return token;
        }

        private static string Transform(string name)
        {
            return name.Substring(0, 1).ToLower() + name.Substring(1);
        }
    }

    internal class Program
    {
        static void Main(string[] args)
        {
            string schema = @"
{
    ""type"": ""object"",
  ""properties"": 
{
                ""countries"": {
                    ""type"": ""array"",
      ""items"": {
                        ""type"": ""string""
      }
                },
    ""address"": {
                    ""type"": ""object"",
      ""properties"": {
                    ""HouseNo"":{
                            ""type"":""number"",
                            ""default"" : 100
                    },
                    ""Street"":{
                            ""type"":""string"",
                            ""default"" : """"
                    },
                    ""city"":{
                            ""type"":""string"",
                            ""default"" : """"
                    },
                    ""Country"":{
                            ""type"":""string"",
                            ""default"" : """"
                    }
                  }
               }
            },
        }";
            var parsedSchema = JSchema.Parse(schema);
            var jsonDocument = JSONGenerator.Generate(parsedSchema);
            Console.WriteLine(jsonDocument.ToString());
            Console.ReadKey();
        }
    }
}


Above code depicts the code which is used to generate default JSON content from the Schema file. JSONGenerator is  a static class which has an API Generate which takes in the JSchema and gives back the root JObject. It is implemented in a recursive fashion which takes care of the nested JSchema types.

Output obtained as a result of executing the above code is shown below:

JSON generated from JSON Schema with default values

As you can see that the values assigned to the properties are the default ones specified in the JSON Schema file.




Comments

Post a Comment

Popular posts from this blog

Creating RESTful Minimal WebAPI in .Net 6 in an Easy Manner! | FastEndpoints

-
Image
  We might have developed Web APIs using MVC Controllers where we used to give Route Path Attributes to the Controller and  to identify individual methods we used to provide Actions in the Route. With the Controller approach we need to write boiler plate code in separate files which deals with the Configuration of the Web Service. Those who have worked in Node js would be aware of how easy it is to create a Web API and expose different Endpoints without the need of so much boiler plate code. Here we are going to discuss of similar approach for creating a Web API in .Net6 using FastEndpoints. Under the hood it uses Minimal API concept which tries to reduce the dependencies required to achieve a particular task. This approach is more suitable in the case of Microservice Architecture where we want to keep the dependencies to minimum. Must Read : Fluent API and Data Annotations What are FastEndpoints? FastEndpoints is a Framework compatible with .Net 6 which allows to build a RESTful Web A
Read more

Mastering Concurrency with Latches and Barriers in C++20: A Practical Guide for Students

-
Image
Introduction Picture yourself as a student tasked with organizing a surprise party for a friend. You have a team of friends helping you, each with a specific role: one decorating, another cooking, and yet another taking care of entertainment. As you plan and coordinate, you quickly realize the importance of timing and synchronization. Just as in party planning, in the world of programming and computing, we often have multiple tasks running concurrently, similar to your friends handling different aspects of the party all at once. However, ensuring that these concurrent tasks harmonize can be a significant challenge. If decorations go up before the food is ready or the entertainment starts before guests arrive, it could lead to chaos. This is where the world of programming comes in, and in this blog, we'll explore powerful tools called "latches" and "barriers" to manage these concurrent scenarios efficiently. Learning about latches and barriers isn't just abou
Read more

Graph Visualization using MSAGL with Examples

-
Image
 Graph visualization is a great way to get a better understanding of complex relationships and structures in data. Whether you work as a software developer, a data scientist, or just want to explore networks, seeing graphs at runtime can be really helpful. In this blog, we'll look at how to make graphs at runtime with MSAGL. We'll cover the basics of creating, customizing, and visualizing graphs with MSAGL, as well as practical examples of how it can be used to create a social network and workflow. What is MSAGL? MSAGL, developed by Microsoft Research, is an open-source library designed for graph and diagram visualization. It offers a wide range of features and layout algorithms to create clear and aesthetically pleasing representations of complex graph structures. Installing MSAGL: To begin, you'll need to install the MSAGL library. You can download the latest version from the official MSAGL GitHub repository or conveniently install it using the NuGet package manager in Vi
Read more