More comprehensive SchemaReferenceId generator

Author: hhvrc

API/Controller/Devices/DevicesController.cs

@@ -25,12 +25,12 @@ public sealed partial class DevicesController
     /// <response code="200">All devices for the current user</response>
     [HttpGet]
     [MapToApiVersion("1")]
-    [ProducesResponseType<LegacyDataResponse<Models.Response.ResponseDevice[]>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
+    [ProducesResponseType<LegacyDataResponse<Models.Response.DeviceResponse[]>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
     public IActionResult ListDevices()
     {
         var devices = _db.Devices
             .Where(x => x.OwnerId == CurrentUser.Id)
-            .Select(x => new Models.Response.ResponseDevice
+            .Select(x => new Models.Response.DeviceResponse
             {
                 Id = x.Id,
                 Name = x.Name,
@@ -47,7 +47,7 @@ public IActionResult ListDevices()
     /// <param name="deviceId"></param>
     /// <response code="200">The device</response>
     [HttpGet("{deviceId}")]
-    [ProducesResponseType<LegacyDataResponse<Models.Response.ResponseDeviceWithToken>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
+    [ProducesResponseType<LegacyDataResponse<Models.Response.DeviceWithTokenResponse>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
     [ProducesResponseType<OpenShockProblem>(StatusCodes.Status404NotFound, MediaTypeNames.Application.ProblemJson)] // DeviceNotFound
     [MapToApiVersion("1")]
     public async Task<IActionResult> GetDeviceById([FromRoute] Guid deviceId)
@@ -56,7 +56,7 @@ public async Task<IActionResult> GetDeviceById([FromRoute] Guid deviceId)
 
 
         var device = await _db.Devices.Where(x => x.OwnerId == CurrentUser.Id && x.Id == deviceId)
-            .Select(x => new Models.Response.ResponseDeviceWithToken
+            .Select(x => new Models.Response.DeviceWithTokenResponse
             {
                 Id = x.Id,
                 Name = x.Name,

API/Controller/Shockers/ListShockers.cs

@@ -15,12 +15,12 @@ public sealed partial class ShockerController
     /// <response code="200">The shockers were successfully retrieved.</response>
     [HttpGet("own")]
     [MapToApiVersion("1")]
-    [ProducesResponseType<LegacyDataResponse<ResponseDeviceWithShockers[]>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
+    [ProducesResponseType<LegacyDataResponse<DeviceWithShockersResponse[]>>(StatusCodes.Status200OK, MediaTypeNames.Application.Json)]
     public IActionResult ListShockers()
     {
         var shockers = _db.Devices
             .Where(x => x.OwnerId == CurrentUser.Id)
-            .OrderBy(x => x.CreatedAt).Select(x => new ResponseDeviceWithShockers
+            .OrderBy(x => x.CreatedAt).Select(x => new DeviceWithShockersResponse
             {
                 Id = x.Id,
                 Name = x.Name,

API/Models/Response/ResponseDevice.cs API/Models/Response/DeviceResponse.csAPI/Models/Response/ResponseDevice.cs renamed to API/Models/Response/DeviceResponse.cs

@@ -1,6 +1,6 @@
 namespace OpenShock.API.Models.Response;
 
-public class ResponseDevice
+public class DeviceResponse
 {
     public required Guid Id { get; init; }
     public required string Name { get; init; }

…s/Response/ResponseDeviceWithShockers.cs …s/Response/DeviceWithShockersResponse.csAPI/Models/Response/ResponseDeviceWithShockers.cs renamed to API/Models/Response/DeviceWithShockersResponse.cs API/Models/Response/ResponseDeviceWithShockers.cs renamed to API/Models/Response/DeviceWithShockersResponse.cs

@@ -1,6 +1,6 @@
 namespace OpenShock.API.Models.Response;
 
-public sealed class ResponseDeviceWithShockers : ResponseDevice
+public sealed class DeviceWithShockersResponse : DeviceResponse
 {
     public required ShockerResponse[] Shockers { get; init; }
 }

…dels/Response/ResponseDeviceWithToken.cs …dels/Response/DeviceWithTokenResponse.csAPI/Models/Response/ResponseDeviceWithToken.cs renamed to API/Models/Response/DeviceWithTokenResponse.cs API/Models/Response/ResponseDeviceWithToken.cs renamed to API/Models/Response/DeviceWithTokenResponse.cs

@@ -1,6 +1,6 @@
 namespace OpenShock.API.Models.Response;
 
-public sealed class ResponseDeviceWithToken : ResponseDevice
+public sealed class DeviceWithTokenResponse : DeviceResponse
 {
     public required string? Token { get; init; }
 }

Common/OpenAPI/OpenApiExtensions.cs

@@ -1,10 +1,77 @@
-using Asp.Versioning.ApiExplorer;
+using System.Text;
+using Asp.Versioning.ApiExplorer;
 using Microsoft.OpenApi;
+using OpenShock.Common.Models;
+using OpenShock.Common.Utils;
 
 namespace OpenShock.Common.OpenAPI;
 
 public static class OpenApiExtensions
 {
+    private static string RemoveResponseSuffix(string name)
+    {
+        string? value;
+        if (StringUtils.TryRemoveSuffix(name, "LegacyResponse", out value)) return value;
+        if (StringUtils.TryRemoveSuffix(name, "Response", out value)) return value;
+        return name;
+    }
+    
+    private static string GetCleanName(Type type)
+    {
+        if (type.IsEnum || Type.GetTypeCode(type) is not TypeCode.Object)
+        {
+            return type.Name;
+        }
+
+        // Handle arrays
+        if (type.IsArray)
+        {
+            return RemoveResponseSuffix(GetCleanName(type.GetElementType()!)) + "Array";
+        }
+    
+        var isGeneric = type.IsGenericType;
+        if (!isGeneric)
+        {
+            if (type == typeof(DateOnly)) return "Date";
+            if (type == typeof(DateTimeOffset)) return "DateTimeWithoutTimeZone";
+            
+            return type.Name;
+        }
+
+        var genericTypeDef = type.GetGenericTypeDefinition();
+        if (genericTypeDef == typeof(List<>) ||
+            genericTypeDef == typeof(IList<>) ||
+            genericTypeDef == typeof(HashSet<>) ||
+            genericTypeDef == typeof(IEnumerable<>) ||
+            genericTypeDef == typeof(IAsyncEnumerable<>))
+        {
+            return RemoveResponseSuffix(GetCleanName(type.GetGenericArguments()[0])) + "Array";
+        }
+
+        if (genericTypeDef == typeof(Dictionary<,>))
+        {
+            return $"DictionaryOf{GetCleanName(type.GetGenericArguments()[0])}And{GetCleanName(type.GetGenericArguments()[1])}";
+        }
+
+
+        if (genericTypeDef == typeof(LegacyDataResponse<>))
+        {
+            return RemoveResponseSuffix(GetCleanName(type.GetGenericArguments()[0])) + "LegacyResponse";
+        }
+    
+        // Handle generic types
+        var genericArgs = string.Join("And", type.GetGenericArguments().Select(GetCleanName));
+    
+        var name = type.Name.AsSpan();
+        var backtickIndex = name.IndexOf('`');
+        if (backtickIndex > 0)
+        {
+            name = name[..backtickIndex];
+        }
+
+        return $"{name}Of{genericArgs}";
+    }
+    
     public static IServiceCollection AddOpenApiExt<TProgram>(this WebApplicationBuilder builder) where TProgram : class
     {
         var assembly = typeof(TProgram).Assembly;
@@ -30,15 +97,7 @@ public static IServiceCollection AddOpenApiExt<TProgram>(this WebApplicationBuil
                     options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1;
                     options.AddDocumentTransformer(DocumentDefaults.GetDocumentTransformer(
                         version: description.ApiVersion.ToString()));
-                    options.CreateSchemaReferenceId = (type) =>
-                    {
-                        var defaultName = type.Type.Name;
-                        var cleanName = defaultName
-                            .Replace("[]", "Array")
-                            .Replace("`1", "Of")
-                            .Replace("`2", "OfTwo");
-                        return cleanName;
-                    };
+                    options.CreateSchemaReferenceId = type => GetCleanName(type.Type);
                     options.AddOperationTransformer((operation, context, cancellationToken) =>
                     {
                         var actionDescriptor = context.Description.ActionDescriptor;

Common/Utils/StringUtils.cs

@@ -1,9 +1,22 @@
-namespace OpenShock.Common.Utils;
+using System.Diagnostics.CodeAnalysis;
+
+namespace OpenShock.Common.Utils;
 
 public static class StringUtils
 {
     public static string Truncate(this string input, int maxLength)
     {
         return input.Length <= maxLength ? input : input[..maxLength];
     }
+    public static bool TryRemoveSuffix(string str, string suffix, [NotNullWhen(true)] out string? value)
+    {
+        if (!str.EndsWith(suffix))
+        {
+            value = null;
+            return false;
+        }
+        
+        value = str[..^suffix.Length];
+        return true;
+    }
 }