#1397 Add polymorphism support to generated OpenAPI json and UI:

- Moved polymorhic classes declaration to module manifest, e.g.:
    <openAPIPolymorphicTypes>        <assemblyQualifiedTypeName>VirtoCommerce.Domain.Cart.Model.LineItem, VirtoCommerce.Domain</assemblyQualifiedTypeName>
    </openAPIPolymorphicTypes>
Need to use assembly qualified names here;
- Removed attribute that marks class polymorphic for swagger;
- All polymorhic classes should have "Type" property to store type information - Type.Name (or Type.FullName, if UseFullTypeNameInSwagger is set to true for module);

Author: yecli

VirtoCommerce.Platform.Core/Common/PolymorphicBaseClassAttribute.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using VirtoCommerce.Platform.Core.Common;
 
@@ -62,11 +62,13 @@ public ManifestModuleInfo(ModuleManifest manifest)
                 Groups.AddRange(manifest.Groups);
             }
             Incompatibilities = new List<ModuleIdentity>();
-            if(manifest.Incompatibilities != null)
+            if (manifest.Incompatibilities != null)
             {
                 Incompatibilities.AddRange(manifest.Incompatibilities.Select(x => new ModuleIdentity(x.Id, x.Version)));
             }
 
+            OpenAPIPolymorphicTypes = manifest.OpenAPIPolymorphicTypes?.Select(x => x.Trim()) ?? Enumerable.Empty<string>();
+
             InitializationMode = InitializationMode.OnDemand;
         }
 
@@ -101,6 +103,7 @@ public ManifestModuleInfo(ModuleManifest manifest)
         public ICollection<ModuleSettingsGroup> Settings { get; private set; }
         public ICollection<string> Errors { get; set; }
         public bool UseFullTypeNameInSwagger { get; set; }
+        public IEnumerable<string> OpenAPIPolymorphicTypes { get; private set; }
 
         public override string ToString()
         {

VirtoCommerce.Platform.Core/Modularity/ManifestModuleInfo.cs

@@ -1,4 +1,4 @@
-using System.Xml.Serialization;
+using System.Xml.Serialization;
 
 namespace VirtoCommerce.Platform.Core.Modularity
 {
@@ -88,5 +88,9 @@ public class ModuleManifest
 
         [XmlElement("useFullTypeNameInSwagger")]
         public bool UseFullTypeNameInSwagger { get; set; }
+
+        [XmlArray("openAPIPolymorphicTypes")]
+        [XmlArrayItem("assemblyQualifiedTypeName")]
+        public string[] OpenAPIPolymorphicTypes { get; set; }
     }
 }

VirtoCommerce.Platform.Core/Modularity/ModuleManifest.cs

@@ -78,7 +78,6 @@
     <Compile Include="Common\IValueObject.cs" />
     <Compile Include="Common\ObservableChangeTracker.cs" />
     <Compile Include="Common\PlatformVersion.cs" />
-    <Compile Include="Common\PolymorphicBaseClassAttribute.cs" />
     <Compile Include="Common\PredicateBuilder.cs" />
     <Compile Include="Common\PrimaryKeyResolvingMap.cs" />
     <Compile Include="Common\SemanticVersion.cs" />

VirtoCommerce.Platform.Core/VirtoCommerce.Platform.Core.csproj

@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using Swashbuckle.Swagger;
-using VirtoCommerce.Platform.Core.Common;
 
 namespace VirtoCommerce.Platform.Web.Swagger
 {
@@ -26,7 +25,7 @@ public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, Sys
 
         private static void RegisterSubClasses(SchemaRegistry schemaRegistry, Type abstractType)
         {
-            var discriminatorName = abstractType.GetAttributeValue<PolymorphicBaseClassAttribute, string>(x => x.DiscriminatorPropertyName) ?? "type";
+            var discriminatorName = "type";
 
             // Need to make first property character lower to avoid properties duplication because of case, as all properties in OpenApi spec are in camelCase
             discriminatorName = char.ToLowerInvariant(discriminatorName[0]) + discriminatorName.Substring(1);

VirtoCommerce.Platform.Web/Swagger/PolymorphismDocumentFilter.cs

@@ -21,10 +21,10 @@ private HashSet<Type> Init()
         {
             var result = new HashSet<Type>();
 
-            var derivedTypes = _types.SelectMany(x =>
-                x.Assembly
-                .GetTypes()
-                .Where(y => x != y && y.IsAssignableFrom(x)));
+            var derivedTypes = _types.SelectMany(baseType =>
+                baseType.Assembly
+                    .GetTypes()
+                    .Where(derivedType => baseType != derivedType && baseType.IsAssignableFrom(derivedType)));
 
             foreach (var item in derivedTypes)
             {
@@ -46,8 +46,10 @@ public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
                     required = schema.required
                 };
 
-                //schemaRegistry.Definitions[typeof(T).Name]; does not work correctly in SwashBuckle
-                var parentSchema = new Schema { @ref = "#/definitions/" + type.BaseType.Name };
+                var baseType = type.BaseType;
+                var baseTypeName = schemaRegistry.Definitions.ContainsKey(baseType.FullName) ? baseType.FullName : baseType.FriendlyId();
+
+                var parentSchema = new Schema { @ref = "#/definitions/" + baseTypeName };
 
                 schema.allOf = new List<Schema> { parentSchema, clonedSchema };
 

VirtoCommerce.Platform.Web/Swagger/PolymorphismSchemaFilter.cs

@@ -14,7 +14,6 @@
 using VirtoCommerce.Platform.Core.Common;
 using VirtoCommerce.Platform.Core.Modularity;
 using VirtoCommerce.Platform.Core.Settings;
-using VirtoCommerce.Platform.Data.Common;
 
 namespace VirtoCommerce.Platform.Web.Swagger
 {
@@ -34,16 +33,22 @@ public static void RegisterRoutes(IUnityContainer container)
             var xmlCommentsFilePaths = xmlCommentsDirectoryPaths.SelectMany(GetXmlFilesPaths).ToArray();
 
             // Add separate swagger generator for platform
-            EnableSwagger("VirtoCommerce.Platform", httpConfiguration, container, routePrefix, xmlCommentsFilePaths, false, Assembly.GetExecutingAssembly());
+            EnableSwagger("VirtoCommerce.Platform", httpConfiguration, container, routePrefix, xmlCommentsFilePaths, false, Assembly.GetExecutingAssembly(), null);
 
             // Add separate swagger generator for each installed module
             var allmodules = container.Resolve<IModuleCatalog>().Modules.OfType<ManifestModuleInfo>().Where(m => m.ModuleInstance != null);
 
+            ICollection<Type> allPolymorphicTypes = new List<Type>();
+
+            // Add separate swagger generator for each installed module
             foreach (var module in allmodules)
             {
-                EnableSwagger(module.ModuleName, httpConfiguration, container, routePrefix, xmlCommentsFilePaths, module.UseFullTypeNameInSwagger, module.ModuleInstance.GetType().Assembly);
+                var polimorphicTypes = GetPolymorphicTypes(module);
+
+                allPolymorphicTypes.AddRange(polimorphicTypes);
+
+                EnableSwagger(module.ModuleName, httpConfiguration, container, routePrefix, xmlCommentsFilePaths, module.UseFullTypeNameInSwagger, module.ModuleInstance.GetType().Assembly, polimorphicTypes);
             }
-            var allModuleAssemblies = allmodules.Select(x => x.ModuleInstance.GetType().Assembly).Concat(new[] { Assembly.GetExecutingAssembly() });
 
             // Add full swagger generator
             httpConfiguration.EnableSwagger(routePrefix + "docs/{apiVersion}", c =>
@@ -67,7 +72,7 @@ public static void RegisterRoutes(IUnityContainer container)
                     .Replace(',', '-')
                 );
 
-                AddProlymorphicFilters(c, allModuleAssemblies);
+                AddProlymorphicFilters(c, allPolymorphicTypes.ToArray());
 
                 ApplyCommonSwaggerConfiguration(c, container, string.Empty, xmlCommentsFilePaths);
             })
@@ -86,7 +91,32 @@ public static void RegisterRoutes(IUnityContainer container)
             });
         }
 
-        private static void EnableSwagger(string moduleName, HttpConfiguration httpConfiguration, IUnityContainer container, string routePrefix, string[] xmlCommentsFilePaths, bool useFullTypeNameInSchemaIds, Assembly apiAssembly)
+        private static Type[] GetPolymorphicTypes(ManifestModuleInfo module)
+        {
+            //TODO: Could move type loading to module loading mechanism with its error handling
+            Type[] polimorphicTypes = null;
+            try
+            {
+                polimorphicTypes = module.OpenAPIPolymorphicTypes
+                    .Select(x => Type.GetType(x, false))
+                    .Where(x => x != null)
+                    .ToArray();
+            }
+            // Need to add catch as even with GetType throwOnError = false it could throw
+            catch { }
+
+            return polimorphicTypes;
+        }
+
+        private static void EnableSwagger(
+            string moduleName,
+            HttpConfiguration httpConfiguration,
+            IUnityContainer container,
+            string routePrefix,
+            string[] xmlCommentsFilePaths,
+            bool useFullTypeNameInSchemaIds,
+            Assembly apiAssembly,
+            Type[] polymorphicTypes)
         {
             var routeName = string.Concat("swagger_", moduleName);
             var routeTemplate = string.Concat(routePrefix, "docs/", moduleName, "/{apiVersion}");
@@ -106,14 +136,13 @@ private static void EnableSwagger(string moduleName, HttpConfiguration httpConfi
                 ApplyCommonSwaggerConfiguration(c, container, moduleName, xmlCommentsFilePaths);
                 c.OperationFilter(() => new ModuleTagsFilter(moduleName));
 
-                AddProlymorphicFilters(c, new[] { apiAssembly });
+                AddProlymorphicFilters(c, polymorphicTypes);
             });
         }
 
-        private static void AddProlymorphicFilters(SwaggerDocsConfig swaggerDocsConfig, IEnumerable<Assembly> assemblies)
+        private static void AddProlymorphicFilters(SwaggerDocsConfig swaggerDocsConfig, Type[] polymorphicTypes)
         {
-            var polymorphicTypes = assemblies.SelectMany(x => x.GetTypesWithAttribute(typeof(PolymorphicBaseClassAttribute), false)).ToArray();
-            if (polymorphicTypes.Any())
+            if (polymorphicTypes?.Any() == true)
             {
                 swaggerDocsConfig.DocumentFilter(() => new PolymorphismDocumentFilter(polymorphicTypes));
                 swaggerDocsConfig.SchemaFilter(() => new PolymorphismSchemaFilter(polymorphicTypes));