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...
Read more

Step By Step Guide to Detect Heap Corruption in Windows Easily

-
Image
Introduction Heap memory corruption is a critical issue that can lead to application crashes, data loss, and even security vulnerabilities. Detecting and addressing heap memory corruption early is crucial for maintaining the stability and security of Windows applications. In this blog post, we will explore how to detect heap memory corruption using two powerful tools: DebugDiag and AppVerifier. Must Read : synchronization in C++20 . Understanding Heap Memory Corruption Heap memory is a dynamically allocated memory space used by applications to store data at runtime. Heap memory corruption occurs when an application writes data beyond the allocated memory boundaries , leading to memory leaks, crashes, and unpredictable behavior. Detecting such corruption manually can be time-consuming and complex, making automated tools invaluable for identifying and diagnosing these issues. What is PageHeap? PageHeap specifically focuses on detecting heap-related problems, like heap overflows, heap und...
Read more

How to dynamically add Properties in C# .NET?

-
Image
There are certain situations where we have to create object dynamically with properties added to the object dynamically. Data related to these properties may be coming in from external sources like a file or from any other serialized format. We can achieve this with the help of reflection, but it is bit complex and should have some prior knowledge of Reflection. What is meant by Dynamic Creation of Properties in c#? Dynamic creation of properties means at the time of writing the code, programmer is not aware of the properties which can be part of the object and its value. For Example there may be some data which needs to be read from say xml file, In this case there should be some organized way by which we can represent the data, This can be in the form of a object. Content of this object and the properties cannot be deduced while writing the application, it needs to be constructed from the xml file which is read when the application runs. Expando Object Expando Object comes to the res...
Read more