How to Validate JSON in C# Effortlessly using JSON Schema file?

-

 There are situations where we may need to validate JSON data which we are receiving from external sources. This is done to ensure data integrity. This can be done easily with the help of a JSON Schema file which lists down the constraints and the template of JSON data.

Validating JSON using JSON Schema in C#

In this post we are going to see with an example, How we can validate the JSON data against the JSON Schema we are using. For this I have created a JSON Schema which lays down the template for the JSON data along with the constraints for the properties of JSON data. Next is to create the JSON data, for this demo, I have hardcoded the JSON data as a string.

Below code demonstrates these in action:

 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
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Schema;
using System;
using System.Collections.Generic;

namespace JSONGeneratorFromSchema
{
    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 jsonData = @"
            {
                ""countries"" : [""Germany"",""USA"",""India""],
                ""address"" : {
                    ""HouseNo"" : 103,
                    ""Street"" : ""Street A"",
                    ""city"" : ""CityA"",
                    ""Country"" : ""CountryA""
                }
            }
";
            JObject jObj = JObject.Parse(jsonData);
            if(!jObj.IsValid(parsedSchema,out IList<ValidationError> errorMessages))
            {
                foreach (var error in errorMessages)
                {
                    Console.WriteLine($"{error.Message} : {error.Path}");
                }
            }
            Console.ReadLine();
        }
    }
}

As we can see from the above code I have used IsValid Extension API of JObject to validate the JSON Object against the schema. In the above code JSON data is valid as it satisfies all the constrains laid out by the JSON Schema.

For catching any error occurred during the validation phase we can supply a second argument to the IsValid API as an out param which captures the Validation Errors. In this example I have printed the Validation Error Message and the JSON Path where the error has occurred.

To demonstrate the validation error I changed the HouseNo from number to string as shown in the below code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 var jsonData = @"
            {
                ""countries"" : [""Germany"",""USA"",""India""],
                ""address"" : {
                    ""HouseNo"" : ""103"",
                    ""Street"" : ""Street A"",
                    ""city"" : ""CityA"",
                    ""Country"" : ""CountryA""
                }
            }

After making this change if we try to run the application it will throw Validation error in the console as shown in the figure below:

JSON Validation Error Message

As seen from the above output we will be able to see the Validation error message and the exact path where the error has occurred.



Conclusion

Validation is a powerful tool to ensure the Data Integrity. JSON being the widely used data format in many applications, Validation against JSON Schema acts as a Safety net.  Troubleshooting Validation issues is also straight-forward with the support provided by the Validation API.



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