madskristensen / jsonschemagenerator

A Visual Studio extension

JSON Schema Generator

Download this extension from the Visual Studio Marketplace or get the CI build.

---

Allows you to easily generate a schema file from a JSON file and generate a JSON file with dummy data based on a schema file.

Generate JSON Schema

Right-click your JSON file in the editor window and select Extract JSON Schema. A new file will be created with the same name as the JSON file, but with the extension .schema.json.

You'll be asked where to place the generated file before it's being generated. Once created, the new schema will be applied to the document automtically.

Generate files from a JSON Schema

If you already have a local JSON schema file, you can generate files in different formats based on it.

JSON

To generate a JSON file with dummy data, select the command Generate JSON Sample from Schema. The new sample JSON file will automatically get the schema applied to it.

C#

To generate a C# class file, select the command Generate C# Model.... This will open a dialog for you to select various settings.

TypeScript

To generate TypeScript types based on the JSON Schema, select the command Generate TypeScript Model.

Powered by NJsonSchema for .NET written by Rico Suter

How can I help?

If you enjoy using the extension, please give it a ★★★★★ rating on the Visual Studio Marketplace.

Should you encounter bugs or if you have feature requests, head on over to the GitHub repo to open an issue if one doesn't already exist.

Pull requests are also very welcome, since I can't always get around to fixing all bugs myself. This is a personal passion project, so my time is limited.

Another way to help out is to sponsor me on GitHub.

jsonschemagenerator's Issues

Dont see the extension in Visual Studio 2022 Enterprise Question

Hi @madskristensen

When inside a json schema it works fine to generate classes. Thats good.
Found it. No problem

//Regards Niklas

Exception on C# Model Generation

Describe the bug
Trying to create C# model and it crashes. Did not have time to debug myself...

To Reproduce
Steps to reproduce the behavior:

1. Right click > Generate C# Model

Expected behavior
C# File :)

Screenshots
Exception:
Newtonsoft.Json.JsonSerializationException: Error converting value True to type 'System.Collections.Generic.ICollection1[System.String]'. Path 'properties.network.required', line 9, position 19. ---> System.ArgumentException: Could not cast or convert from System.Boolean to System.Collections.Generic.ICollection1[System.String].
at Newtonsoft.Json.Utilities.ConvertUtils.EnsureTypeAssignable(Object value, Type initialType, Type targetType)
at Newtonsoft.Json.Utilities.ConvertUtils.ConvertOrCast(Object initialValue, CultureInfo culture, Type targetType)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.EnsureType(JsonReader reader, Object value, CultureInfo culture, JsonContract contract, Type targetType)
--- End of inner exception stack trace ---
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.EnsureType(JsonReader reader, Object value, CultureInfo culture, JsonContract contract, Type targetType)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateValueInternal(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.SetPropertyValue(JsonProperty property, JsonConverter propertyConverter, JsonContainerContract containerContract, JsonProperty containerProperty, JsonReader reader, Object target)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.PopulateObject(Object newObject, JsonReader reader, JsonObjectContract contract, JsonProperty member, String id)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Populate(JsonReader reader, Object target)
at NJsonSchema.ExtensionDataDeserializationConverter.ReadJson(JsonReader reader, Type objectType, Object existingValue, JsonSerializer serializer)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.DeserializeConvertable(JsonConverter converter, JsonReader reader, Type objectType, Object existingValue)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.PopulateDictionary(IDictionary dictionary, JsonReader reader, JsonDictionaryContract contract, JsonProperty containerProperty, String id)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateObject(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateValueInternal(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.SetPropertyValue(JsonProperty property, JsonConverter propertyConverter, JsonContainerContract containerContract, JsonProperty containerProperty, JsonReader reader, Object target)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.PopulateObject(Object newObject, JsonReader reader, JsonObjectContract contract, JsonProperty member, String id)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Populate(JsonReader reader, Object target)
at NJsonSchema.ExtensionDataDeserializationConverter.ReadJson(JsonReader reader, Type objectType, Object existingValue, JsonSerializer serializer)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.DeserializeConvertable(JsonConverter converter, JsonReader reader, Type objectType, Object existingValue)
at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Deserialize(JsonReader reader, Type objectType, Boolean checkAdditionalContent)
at Newtonsoft.Json.JsonSerializer.DeserializeInternal(JsonReader reader, Type objectType)
at Newtonsoft.Json.JsonSerializer.Deserialize[T](JsonReader reader)
at NJsonSchema.Infrastructure.JsonSchemaSerialization.FromJson[T](Stream stream, IContractResolver contractResolver)
at NJsonSchema.Infrastructure.JsonSchemaSerialization.d__16`1.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at JsonSchemaGenerator.GenerateCSharpCommand.d__1.MoveNext() in D:\a\JsonSchemaGenerator\JsonSchemaGenerator\src\Commands\GenerateCSharpCommand.cs:line 58
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at JsonSchemaGenerator.GenerateCSharpCommand.d__0.MoveNext() in D:\a\JsonSchemaGenerator\JsonSchemaGenerator\src\Commands\GenerateCSharpCommand.cs:line 17
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at Community.VisualStudio.Toolkit.BaseCommand.<>c__DisplayClass8_0.<b__0>d.MoveNext()

OverseasSendPropertyDetailsRequestSchema.json

Additional context
Not quite sure if this schema was an "expected" format but technically speaking it is of formatting:
"$schema": "http://json-schema.org/draft-03/schema#"

Yaml support

Is your feature request related to a problem? Please describe.

Thanks for the great extension! I hope this can generate schema for yml file as well