Merge pull request #17 from IvanMurzak/fix/output-schema

Enhance JSON schema generation with $defs support and 'result' property

Author: IvanMurzak

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "cSpell.words": [
         "unstringified",
-        "Unstringify"
+        "Unstringify",
+        "Xunit"
     ]
 }

README.md

@@ -372,7 +372,7 @@ jsonSerializer.AddConverter(new MyCustomJsonConverter());
 
 // Access to JSON schema generation
 var jsonSchema = reflector.JsonSchema;
-var schema = jsonSchema.GetSchema<MyClass>(reflector, justRef: false);
+var schema = jsonSchema.GetSchema<MyClass>(reflector);
 ```
 
 #### Converter System Architecture

ReflectorNet.Tests.OuterAssembly/Model/Complex_Address.cs

@@ -0,0 +1,11 @@
+// Complex class: Address with multiple properties
+namespace com.IvanMurzak.ReflectorNet.OuterAssembly.Model
+{
+    public class Address
+    {
+        public string Street { get; set; } = string.Empty;
+        public string City { get; set; } = string.Empty;
+        public string? Zip { get; set; }
+        public string Country { get; set; } = string.Empty;
+    }
+}

ReflectorNet.Tests.OuterAssembly/Model/Complex_Company.cs

@@ -0,0 +1,14 @@
+// Complex class: Company with nested collections and references
+using System.Collections.Generic;
+
+namespace com.IvanMurzak.ReflectorNet.OuterAssembly.Model
+{
+    public class Company
+    {
+        public string Name { get; set; } = string.Empty;
+        public Address? Headquarters { get; set; }
+        public List<Person> Employees { get; } = new List<Person>();
+        public Dictionary<string, List<Person>> Teams { get; } = new Dictionary<string, List<Person>>();
+        public Dictionary<string, Dictionary<string, Person>> Directory { get; } = new();
+    }
+}

ReflectorNet.Tests.OuterAssembly/Model/Complex_Person.cs

@@ -0,0 +1,32 @@
+// Complex class: Person with mixed fields/properties and nested types
+using System;
+using System.Collections.Generic;
+
+namespace com.IvanMurzak.ReflectorNet.OuterAssembly.Model
+{
+    public class Person
+    {
+        // Fields
+        public string FirstName = string.Empty;
+        public string LastName = string.Empty;
+        private DateTime _birthDate;
+
+        // Properties
+        public int Age { get; set; }
+        public Address? Address { get; set; }
+        public List<string> Tags { get; } = new List<string>();
+        public Dictionary<string, int> Scores { get; } = new Dictionary<string, int>();
+
+        // Arrays
+        public int[] Numbers { get; set; } = Array.Empty<int>();
+        public string[][] JaggedAliases { get; set; } = Array.Empty<string[]>();
+        public int[,] Matrix2x2 { get; set; } = new int[2, 2];
+
+        // Methods using primitives and collections
+        public void SetBirthDate(DateTime date) => _birthDate = date;
+        public DateTime GetBirthDate() => _birthDate;
+
+        public void AddTag(string tag) => Tags.Add(tag);
+        public void SetScore(string key, int value) => Scores[key] = value;
+    }
+}

ReflectorNet.Tests.OuterAssembly/Model/NestedClass.cs

@@ -45,5 +45,24 @@ public class WrapperClass<T>
         [JsonInclude]
         public T? ValueField;
         public T? ValueProperty { get; set; }
+
+        public WrapperClass() { }
+        public WrapperClass(T? valueField, T? valueProperty)
+        {
+            ValueField = valueField;
+            ValueProperty = valueProperty;
+        }
+
+        /// <summary>
+        /// Echo method that returns the provided value unchanged.
+        /// Used for testing return type schemas with various generic types.
+        /// </summary>
+        public T Echo(T value) => value;
+
+        /// <summary>
+        /// Echo method that returns a nullable version of the provided value.
+        /// Used for testing return type schemas with nullable generic types.
+        /// </summary>
+        public T? EchoNullable(T? value) => value;
     }
 }

ReflectorNet.Tests/JsonConverterTests/JsonConverterTests.cs

@@ -1,4 +1,5 @@
-using com.IvanMurzak.ReflectorNet.Tests.Model;
+using com.IvanMurzak.ReflectorNet.OuterAssembly.Model;
+using com.IvanMurzak.ReflectorNet.Tests.Model;
 using Xunit.Abstractions;
 
 namespace com.IvanMurzak.ReflectorNet.Tests.Utils

ReflectorNet.Tests/Model/JsonConvertors/ObjectRefConverter.cs

@@ -1,16 +1,15 @@
 using System;
+using System.Collections.Generic;
 using System.Text.Json;
 using System.Text.Json.Nodes;
-using System.Text.Json.Serialization;
 using com.IvanMurzak.ReflectorNet.Json;
 using com.IvanMurzak.ReflectorNet.Utils;
 
 namespace com.IvanMurzak.ReflectorNet.Tests.Model
 {
-    public class ObjectRefConverter : JsonConverter<ObjectRef>, IJsonSchemaConverter
+    public class ObjectRefConverter : JsonSchemaConverter<ObjectRef>, IJsonSchemaConverter
     {
-        public string Id => typeof(ObjectRef).GetTypeId();
-        public JsonNode GetScheme() => new JsonObject
+        public override JsonNode GetSchema() => new JsonObject
         {
             [JsonSchema.Type] = JsonSchema.Object,
             [JsonSchema.Properties] = new JsonObject
@@ -21,7 +20,7 @@ public class ObjectRefConverter : JsonConverter<ObjectRef>, IJsonSchemaConverter
             },
             [JsonSchema.Required] = new JsonArray { nameof(ObjectRef.instanceID) }
         };
-        public JsonNode GetSchemeRef() => new JsonObject
+        public override JsonNode GetSchemaRef() => new JsonObject
         {
             [JsonSchema.Ref] = JsonSchema.RefValue + Id
         };

ReflectorNet.Tests/Model/JsonConvertors/SerializedMemberCustomDescriptionConverter.cs

@@ -1,18 +1,16 @@
 using System;
 using System.Text.Json;
 using System.Text.Json.Nodes;
-using System.Text.Json.Serialization;
 using com.IvanMurzak.ReflectorNet.Json;
 using com.IvanMurzak.ReflectorNet.Model;
 using com.IvanMurzak.ReflectorNet.Utils;
 
 namespace com.IvanMurzak.ReflectorNet.Tests.Model
 {
-    public class SerializedMemberCustomDescriptionConverter : JsonConverter<SerializedMember>, IJsonSchemaConverter
+    public class SerializedMemberCustomDescriptionConverter : JsonSchemaConverter<SerializedMember>, IJsonSchemaConverter
     {
         public const string CustomDescription = "Custom description, used for testing purposes.";
 
-        public static string StaticId => TypeUtils.GetTypeId<SerializedMember>();
         public static JsonNode Schema => new JsonObject
         {
             [JsonSchema.Type] = JsonSchema.Object,
@@ -64,15 +62,13 @@ public class SerializedMemberCustomDescriptionConverter : JsonConverter<Serializ
 
         readonly Reflector _reflector;
 
-        public string Id => StaticId;
-
         public SerializedMemberCustomDescriptionConverter(Reflector reflector)
         {
             _reflector = reflector ?? throw new ArgumentNullException(nameof(reflector));
         }
 
-        public JsonNode GetSchemeRef() => SchemaRef;
-        public JsonNode GetScheme() => Schema;
+        public override JsonNode GetSchemaRef() => SchemaRef;
+        public override JsonNode GetSchema() => Schema;
 
         public override SerializedMember? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
         {