Generating JSON schema from C# class

Question

Is there any way to programmatically generate a JSON schema from a C# class?

Something which we can do manually using http://www.jsonschema.net/

Nobody picked up that site doesn't generate schema from C#, but from JSON. And the previous comment's link is C# to JSON, not schema. This however is one way to do it online. https://dotnetfiddle.net/sjmS9Z — codah, Oct 21 '20 at 00:46

Rico Suter · Accepted Answer · 2020-12-04T23:33:27.897

42

Another option which supports generating JSON Schema v4 is NJsonSchema:

var schema = JsonSchema.FromType<Person>();
var schemaJson = schema.ToJson();

The library can be installed via NuGet.

Update for NJsonSchema v9.4.3+:

using NJsonSchema;

var schema = await JsonSchema.FromTypeAsync<Person>();
var schemaJson = schema.ToJson();

edited Dec 04 '20 at 23:33

answered Oct 12 '15 at 12:32

Rico Suter

11,548
6
67
93

score 8 · Answer 2 · answered Oct 12 '21 at 13:12

8

This is supported in Json.NET via the Newtonsoft.Json.Schema NuGet package. Instructions on how to use it can be found in the official documentation, but I've also included a simple example below.

JSchemaGenerator generator = new JSchemaGenerator();
JSchema schema = generator.Generate(typeof(Person));
Console.WriteLine(schema.ToString());
//{
//  "type": "object",
//  "properties": {
//    "Name": {
//      "type": [ "string", "null" ]
//    },
//    "Age": { "type": "integer" }
//  },
//  "required": [ "Name", "Age" ]
//}

answered Oct 12 '21 at 13:12

mark.monteiro

2,609
2
33
38

2

Please note that licensing may be a thing when using the newtonsoft json schema package – Marc Wittmann Jul 26 '23 at 10:52
Good point, the licensing/pricing information can be found here: https://www.newtonsoft.com/store/jsonschema – mark.monteiro Jul 26 '23 at 18:22

Daniel · Answer 3 · 2017-08-14T22:23:13.950

2

JsonSchemaGenerator js = new JsonSchemaGenerator();
var schema = js.Generate(typeof(Person));
schema.Title = typeof(Person).Name;
using (StreamWriter fileWriter = File.CreateText(filePath))
{
      fileWriter.WriteLine(schema);
}

edited Aug 14 '17 at 22:23

answered Aug 11 '17 at 21:59

Daniel

984
8
14

1

It not free, it has 10 time for hours – Mario Villanueva Sep 10 '20 at 19:35

Stefan Steiger · Answer 4 · 2016-01-13T13:43:18.350

1

For those who land here from google searching for the reverse
(generate the C# class from JSON) - I use those fine online tools:

JSON:
http://json2csharp.com/
(Source: http://jsonclassgenerator.codeplex.com/)

XML:
http://xmltocsharp.azurewebsites.net/
(Source: https://github.com/msyoung/XmlToCSharp)

edited Jan 13 '16 at 13:43

answered Sep 06 '15 at 12:01

Stefan Steiger

78,642
66
377
442

2

From reverse jsonclassgenerator tool is great. Another simple option is to use Edit->Paste Special-> Paste JSON as Classes in Visual Studio. This creates a class too! Quite handy sometimes. – sandiejat Mar 16 '17 at 05:25
@sandiejat: Nice to know. Wonder since which version of VS. – Stefan Steiger Mar 16 '17 at 19:17
Seems like 2012.2 RC brought it. And we were busy doing it difficult way! :) https://blogs.msdn.microsoft.com/webdev/2012/12/18/paste-json-as-classes-in-asp-net-and-web-tools-2012-2-rc/ – sandiejat Mar 16 '17 at 23:09

Generating JSON schema from C# class

4 Answers4

Linked