fix api ui, add versions

.github/workflows/nuget-publish.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Publish
         run: |
           version=`git describe --tags`
-          dotnet build --configuration release -p:PackageVersion=$version
+          dotnet build --configuration release -p:Version=$version
           dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
         env:
           NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}

Attributes/SimApiDocAttribute.cs

@@ -16,7 +16,7 @@ public class SimApiDocAttribute : SwaggerOperationAttribute
     /// <param name="name">接口名称</param>
     public SimApiDocAttribute(string tag, string name)
     {
-        Tags = new[] { tag };
+        Tags = [tag];
         Summary = name;
         // Consumes = new[] {"application/json"};
         // Produces = new[] {"application/json"};

Communications/SimApiBaseResponse.cs

@@ -13,6 +13,10 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
     public int Code { get; set; } = code;
     public string Message { get; set; } = message;
 
+    public SimApiBaseResponse() : this(200, "成功")
+    {
+    }
+
     /// <summary>
     /// 默认错误代码对应提示信息
     /// </summary>

Configurations/SimApiOptions.cs

@@ -74,6 +74,14 @@ public class SimApiOptions
     public bool EnableLowerUrl { get; set; } = true;
 
 
+    /// <summary>
+    /// 应用可以通过 /versions 显示出应用版本和SimApi包版本
+    /// default: true
+    /// </summary>
+    public bool EnableVersionUrl { get; set; } = true;
+
+
+
     /// <summary>
     /// 启用格式化的 Console Logger
     /// default: false

Controllers/SimApiBaseController.cs

@@ -14,6 +14,9 @@ namespace SimApi.Controllers;
 /// 2. 报错返回
 /// 3. 错误回馈页面
 /// </summary>
+///
+[Consumes("application/json")]
+[Produces("application/json")]
 public class SimApiBaseController : Controller
 {
     /// <summary>

Controllers/SimApiCommonController.cs

@@ -1,9 +1,11 @@
-using Microsoft.AspNetCore.Mvc;
+using System.Collections.Generic;
+using Microsoft.AspNetCore.Mvc;
 using SimApi.Attributes;
 using SimApi.Communications;
 using SimApi.Helpers;
 
 namespace SimApi.Controllers;
+
 public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
 {
     /// <summary>
@@ -25,7 +27,7 @@ public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
     [HttpPost, SimApiDoc("认证", "检测登陆")]
     public SimApiBaseResponse<string> CheckLogin()
     {
-        ErrorWhenNull(LoginInfo, 401,"未登录");
+        ErrorWhenNull(LoginInfo, 401, "未登录");
         return new SimApiBaseResponse<string>
         {
             Data = LoginInfo.Id
@@ -50,7 +52,20 @@ public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
         return new SimApiBaseResponse();
     }
 
-    [HttpPost,SimApiAuth]
+    [HttpPost, HttpGet]
+    public SimApiBaseResponse<Dictionary<string, string>> Versions()
+    {
+        return new SimApiBaseResponse<Dictionary<string, string>>()
+        {
+            Data = new Dictionary<string, string>
+            {
+                { "SimApi", SimApiUtil.SimApiVersion },
+                { "App", SimApiUtil.AppVersion }
+            }
+        };
+    }
+
+    [HttpPost, SimApiAuth]
     public SimApiBaseResponse<SimApiLoginItem> UserInfo()
     {
         return new SimApiBaseResponse<SimApiLoginItem>(LoginInfo);

Helpers/SimApiAesUtil.cs

@@ -0,0 +1,119 @@
+using System;
+using System.IO;
+using System.Security.Cryptography;
+using System.Text;
+
+namespace SimApi.Helpers;
+
+public static class SimApiAesUtil
+{
+    // 密钥长度：256位 (32字节)
+    private const int KeySize = 256;
+
+    // 块大小：128位 (16字节)
+    private const int BlockSize = 128;
+
+    // 加密模式 - 重命名以避免与枚举类型冲突
+    private const CipherMode AesCipherMode = CipherMode.CBC;
+
+    // 填充模式 - 重命名以避免与枚举类型冲突
+    private const PaddingMode AesPaddingMode = PaddingMode.PKCS7;
+
+    /// <summary>
+    /// AES 加密
+    /// </summary>
+    /// <param name="plainText">明文</param>
+    /// <param name="key">字符串密钥（将被处理为256位）</param>
+    /// <returns>加密后的Base64字符串（包含IV）</returns>
+    public static string Encrypt(string plainText, string key)
+    {
+        if (string.IsNullOrEmpty(plainText))
+            throw new ArgumentNullException(nameof(plainText));
+        if (string.IsNullOrEmpty(key))
+            throw new ArgumentNullException(nameof(key));
+
+        // 处理密钥为指定长度
+        var keyBytes = ProcessKey(key);
+        // 生成随机IV
+        var iv = GenerateRandomIv();
+
+        using var aes = CreateAesProvider(keyBytes, iv);
+        using var encryptor = aes.CreateEncryptor(aes.Key, aes.IV);
+        using var ms = new MemoryStream();
+        // 先写入IV，解密时需要用到
+        ms.Write(iv, 0, iv.Length);
+
+        using (var cs = new CryptoStream(ms, encryptor, CryptoStreamMode.Write))
+        using (var sw = new StreamWriter(cs))
+        {
+            sw.Write(plainText);
+        }
+
+        return Convert.ToBase64String(ms.ToArray());
+    }
+
+    /// <summary>
+    /// AES 解密
+    /// </summary>
+    /// <param name="cipherText">加密后的Base64字符串</param>
+    /// <param name="key">字符串密钥（与加密时相同）</param>
+    /// <returns>解密后的明文</returns>
+    public static string Decrypt(string cipherText, string key)
+    {
+        if (string.IsNullOrEmpty(cipherText))
+            throw new ArgumentNullException(nameof(cipherText));
+        if (string.IsNullOrEmpty(key))
+            throw new ArgumentNullException(nameof(key));
+
+        var cipherBytes = Convert.FromBase64String(cipherText);
+
+        // 从加密数据中提取IV
+        var iv = new byte[BlockSize / 8];
+        Array.Copy(cipherBytes, 0, iv, 0, iv.Length);
+
+        // 处理密钥为指定长度
+        var keyBytes = ProcessKey(key);
+
+        using var aes = CreateAesProvider(keyBytes, iv);
+        using var decryptor = aes.CreateDecryptor(aes.Key, aes.IV);
+        using var ms = new MemoryStream(cipherBytes, iv.Length, cipherBytes.Length - iv.Length);
+        using var cs = new CryptoStream(ms, decryptor, CryptoStreamMode.Read);
+        using var sr = new StreamReader(cs);
+        return sr.ReadToEnd();
+    }
+
+    /// <summary>
+    /// 处理密钥为指定长度（256位）
+    /// </summary>
+    private static byte[] ProcessKey(string key)
+    {
+        // 使用SHA256哈希处理密钥，确保得到32字节(256位)的密钥
+        return SHA256.HashData(Encoding.UTF8.GetBytes(key));
+    }
+
+    /// <summary>
+    /// 生成随机初始化向量
+    /// </summary>
+    private static byte[] GenerateRandomIv()
+    {
+        using var aes = Aes.Create();
+        aes.BlockSize = BlockSize;
+        aes.GenerateIV();
+        return aes.IV;
+    }
+
+    /// <summary>
+    /// 创建并配置AES加密服务提供器
+    /// </summary>
+    private static Aes CreateAesProvider(byte[] key, byte[] iv)
+    {
+        var aes = Aes.Create();
+        aes.KeySize = KeySize;
+        aes.BlockSize = BlockSize;
+        aes.Mode = AesCipherMode;
+        aes.Padding = AesPaddingMode;
+        aes.Key = key;
+        aes.IV = iv;
+        return aes;
+    }
+}

Helpers/SimApiAuthOperationFilter.cs

@@ -0,0 +1,46 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+using SimApi.Attributes;
+
+namespace SimApi.Helpers
+{
+    public class SimApiAuthOperationFilter : IOperationFilter
+    {
+        public void Apply(OpenApiOperation operation, OperationFilterContext context)
+        {
+            // 检查接口或控制器是否标记了 [SimApiAuth] 特性
+            var requiresAuth =
+                // 方法上有 [SimApiAuth]
+                context.MethodInfo.GetCustomAttributes<SimApiAuthAttribute>(true).Any()
+                ||
+                // 控制器上有 [SimApiAuth]（继承到所有方法）
+                context.MethodInfo.DeclaringType?.GetCustomAttributes<SimApiAuthAttribute>(true).Any() == true;
+            if (requiresAuth)
+            {
+                // 添加授权要求：关联步骤 2 中定义的 "SimApiAuth" 安全方案
+                operation.Security = new List<OpenApiSecurityRequirement>
+                {
+                    new OpenApiSecurityRequirement
+                    {
+                        {
+                            new OpenApiSecurityScheme
+                            {
+                                Reference = new OpenApiReference
+                                {
+                                    Type = ReferenceType.SecurityScheme,
+                                    Id = "SimApiAuth" // 必须与 AddSecurityDefinition 的第一个参数一致
+                                }
+                            },
+                            [] // 无需指定作用域（scope）时留空
+                        }
+                    }
+                };
+            }
+            // 未标记 [SimApiAuth] 的接口：不添加安全要求，Swagger 不显示锁图标
+        }
+    }
+}

Helpers/SimApiUtil.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO;
 using System.Linq;
+using System.Reflection;
 using System.Security.Cryptography;
 using System.Text;
 using System.Text.Encodings.Web;
@@ -30,6 +31,53 @@ public static class SimApiUtil
         // DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
     };
 
+    public static string SimApiVersion
+    {
+        get
+        {
+            // 这里使用当前类（属于 NuGet 包）的程序集
+            var assembly = typeof(SimApiUtil).Assembly;
+
+            // 优先获取 AssemblyInformationalVersion（通常对应 NuGet 包版本，可能包含预发布标签）
+            var informationalVersion =
+                assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion;
+            if (!string.IsNullOrEmpty(informationalVersion))
+            {
+                return informationalVersion;
+            }
+
+            // 若不存在，则获取 AssemblyVersion（编译时版本）
+            var version = assembly.GetName().Version?.ToString();
+            return version ?? "Unknown";
+        }
+    }
+
+    public static string AppVersion
+    {
+        get
+        {
+            // 获取外层应用的入口程序集（通常是启动项目的程序集）
+            var entryAssembly = Assembly.GetEntryAssembly();
+            if (entryAssembly == null)
+            {
+                // 特殊场景（如单元测试、某些宿主环境）下，入口程序集可能为 null，可尝试获取调用栈中的上层程序集
+                entryAssembly = Assembly.GetCallingAssembly(); // 或 Assembly.GetExecutingAssembly() 视场景调整
+            }
+
+            // 优先获取应用的 AssemblyInformationalVersion
+            var informationalVersion = entryAssembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()
+                ?.InformationalVersion;
+            if (!string.IsNullOrEmpty(informationalVersion))
+            {
+                return informationalVersion;
+            }
+
+            // 若不存在，则获取 AssemblyVersion
+            var version = entryAssembly.GetName().Version?.ToString();
+            return version ?? "Unknown";
+        }
+    }
+
     /// <summary>
     /// 当前秒级时间戳
     /// </summary>

Helpers/WrapResponseSchemaFilter.cs

@@ -0,0 +1,118 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+using System.Reflection;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using SimApi.Attributes;
+using SimApi.Communications;
+
+namespace SimApi.Helpers;
+
+public class WrapResponseSchemaFilter : IOperationFilter
+{
+    public void Apply(OpenApiOperation operation, OperationFilterContext context)
+    {
+        // 1. 跳过标记了 [OriginResponseAttribute] 的接口（不包装）
+        if (context.MethodInfo.DeclaringType?.GetCustomAttributes<OriginResponseAttribute>(true).Any() == true
+            || context.MethodInfo.GetCustomAttributes<OriginResponseAttribute>(true).Any())
+        {
+            return;
+        }
+
+        // 2. 获取控制器方法声明的“原始返回类型”（如 Task<UserDto> → UserDto）
+        var returnType = GetUnwrappedReturnType(context.MethodInfo.ReturnType, context);
+        if (IsAlreadyWrappedType(returnType))
+        {
+            return; // 保留原始返回类型的文档描述
+        }
+
+        // 3. 定义包装后的目标类型（泛型/非泛型）
+        Type wrappedType;
+        if (returnType == typeof(void) || returnType == typeof(EmptyResult))
+        {
+            // 无数据：用非泛型 SimApiBaseResponse
+            wrappedType = typeof(SimApiBaseResponse);
+        }
+        else
+        {
+            // 有数据：用泛型 SimApiBaseResponse<T>（T 为原始返回类型）
+            wrappedType = typeof(SimApiBaseResponse<>).MakeGenericType(returnType);
+        }
+
+        // 4. 让 Swagger 生成包装类型的 Schema
+        var schema = context.SchemaGenerator.GenerateSchema(wrappedType, context.SchemaRepository);
+
+        // 5. 替换 Swagger 文档中的响应类型（只保留 200 OK 的响应，匹配过滤器逻辑）
+        operation.Responses.Clear(); // 清除默认响应（如 200 返回原始类型）
+        operation.Responses.Add("200", new OpenApiResponse
+        {
+            Description = "请求成功",
+            Content = new Dictionary<string, OpenApiMediaType>
+            {
+                {
+                    "application/json", // 只保留 JSON 格式（配合之前的全局配置）
+                    new OpenApiMediaType
+                    {
+                        Schema = schema
+                    }
+                }
+            }
+        });
+    }
+
+    private static Type GetUnwrappedReturnType(Type returnType, OperationFilterContext context)
+    {
+        // 处理 Task<T>（异步方法）
+        if (returnType.IsGenericType && returnType.GetGenericTypeDefinition() == typeof(Task<>))
+        {
+            returnType = returnType.GetGenericArguments()[0];
+        }
+
+        // 处理 IActionResult/ObjectResult（如 return Ok(userDto)）
+        if (!typeof(IActionResult).IsAssignableFrom(returnType)) return returnType;
+        // 从方法返回语句中提取原始类型（需结合特性，或默认用 object）
+        // 更精准的方式：让控制器方法用 [ProducesResponseType(typeof(UserDto), 200)] 声明原始类型
+        var producesAttr = context.MethodInfo.GetCustomAttributes<ProducesResponseTypeAttribute>()
+            .FirstOrDefault(a => a.StatusCode == 200);
+        if (producesAttr?.Type != null && producesAttr.Type != typeof(void))
+        {
+            return producesAttr.Type;
+        }
+
+        return typeof(object); // 无法识别时默认用 object
+    }
+
+    // 辅助方法：判断类型是否已经是 SimApiBaseResponse 及其泛型
+    private static bool IsAlreadyWrappedType(Type type)
+    {
+        // 情况1：类型本身是 SimApiBaseResponse 或其泛型
+        if (type == typeof(SimApiBaseResponse) ||
+            (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(SimApiBaseResponse<>)))
+        {
+            return true;
+        }
+
+        // 情况2：类型是 SimApiBaseResponse 的子类（非泛型）
+        if (type.IsSubclassOf(typeof(SimApiBaseResponse)))
+        {
+            return true;
+        }
+
+        // 情况3：类型是 SimApiBaseResponse<T> 的子类（泛型）
+        // 检查是否继承自泛型父类 SimApiBaseResponse<>（任意 T）
+        if (type.BaseType is { IsGenericType: true })
+        {
+            var genericBaseType = type.BaseType.GetGenericTypeDefinition();
+            if (genericBaseType == typeof(SimApiBaseResponse<>))
+            {
+                return true;
+            }
+        }
+
+        // 其他情况：不是包装类型或其子类
+        return false;
+    }
+}

SimApi.csproj

@@ -3,17 +3,10 @@
     <PropertyGroup>
         <OutputType>Library</OutputType>
         <PackOnBuild>true</PackOnBuild>
-        <Version>0.2.3</Version>
+        <Version>0.0.0</Version>
         <Authors>xRain@SimcuTeam</Authors>
         <Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
         <PackageId>Simcu.SimApi</PackageId>
-        <IsPackable>true</IsPackable>
-        <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-        <IncludeSymbols>true</IncludeSymbols>
-        <ReleaseVersion>5.0.0</ReleaseVersion>
-        <SynchReleaseVersion>false</SynchReleaseVersion>
-        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <PackageVersion>5.0.2</PackageVersion>
         <Nullable>enable</Nullable>
         <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
     </PropertyGroup>
@@ -23,15 +16,15 @@
         <Folder Include="Exceptions\"/>
     </ItemGroup>
     <ItemGroup>
-        <PackageReference Include="Hangfire.AspNetCore" Version="1.8.18" />
+
-        <PackageReference Include="Hangfire.Console" Version="1.4.3" />
+        <PackageReference Include="Hangfire.AspNetCore" Version="1.8.21" />
-        <PackageReference Include="Hangfire.Redis.StackExchange" Version="1.12.0" />
+        <PackageReference Include="Hangfire.Console" Version="1.4.3"/>
-        <PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="9.0.5" />
+        <PackageReference Include="Hangfire.Redis.StackExchange" Version="1.12.0"/>
-        <PackageReference Include="Minio" Version="6.0.4" />
+        <PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="9.0.10" />
-        <PackageReference Include="MQTTnet" Version="5.0.1.1416" />
+        <PackageReference Include="Minio" Version="6.0.5" />
-        <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="8.1.1" />
+        <PackageReference Include="MQTTnet" Version="5.0.1.1416"/>
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="8.1.1" />
+        <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="9.0.6" />
-        <PackageReference Include="System.Text.Json" Version="9.0.10" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
     </ItemGroup>
     <ProjectExtensions>
         <MonoDevelop>

SimApiExtensions.cs

@@ -121,30 +121,27 @@ public static class SimApiExtensions
                     });
                 }
 
+                x.CustomSchemaIds(type => type.FullName?.Replace("+", "."));
+                x.OperationFilter<WrapResponseSchemaFilter>();
+                if (simApiOptions.EnableSimApiAuth)
+                {
+                    x.OperationFilter<SimApiAuthOperationFilter>();
+                }
+
                 x.EnableAnnotations();
                 var haveOauth = false;
-                var haveSimApiAuth = false;
                 var oauthFlows = new OpenApiOAuthFlows();
                 foreach (var auth in docOptions.ApiAuth.Type)
                 {
                     switch (auth)
                     {
                         case "SimApiAuth":
-                            x.AddSecurityRequirement(new OpenApiSecurityRequirement
+                            x.AddSecurityDefinition("HeaderToken",
-                            {
-                                {
                                 new OpenApiSecurityScheme
                                 {
-                                        Reference = new OpenApiReference
+                                    Name = "Token",
-                                        {
+                                    In = ParameterLocation.Header
-                                            Type = ReferenceType.SecurityScheme,
-                                            Id = "HeaderToken"
-                                        }
-                                    },
-                                    new[] { "readAccess", "writeAccess" }
-                                }
                                 });
-                            haveSimApiAuth = true;
                             break;
                         case "ClientCredentials":
                             oauthFlows.ClientCredentials = new OpenApiOAuthFlow
@@ -193,30 +190,6 @@ public static class SimApiExtensions
                         Description = docOptions.ApiAuth.Description,
                         In = ParameterLocation.Header
                     });
-                    x.AddSecurityRequirement(new OpenApiSecurityRequirement
-                    {
-                        {
-                            new OpenApiSecurityScheme
-                            {
-                                Reference = new OpenApiReference
-                                {
-                                    Type = ReferenceType.SecurityScheme,
-                                    Id = "oauth2"
-                                }
-                            },
-                            ["SimApiAuth"]
-                        }
-                    });
-                }
-
-                if (haveSimApiAuth)
-                {
-                    x.AddSecurityDefinition("HeaderToken",
-                        new OpenApiSecurityScheme
-                        {
-                            Name = "Token",
-                            In = ParameterLocation.Header
-                        });
                 }
             });
         }
@@ -264,6 +237,8 @@ public static class SimApiExtensions
         var logger = builder.Services.GetRequiredService<ILogger<SimApiOptions>>();
 
         logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
+        logger.LogInformation("主应用版本: {AppVersion}\nSimApi版本: {SimApiVersion}", SimApiUtil.AppVersion,
+            SimApiUtil.SimApiVersion);
 
         if (options.RedisConfiguration != null)
         {
@@ -374,11 +349,22 @@ public static class SimApiExtensions
             }
         }
 
+        if (options.EnableVersionUrl)
+        {
+            builder.MapControllerRoute(name: "Versions", pattern: "/versions",
+                defaults: new
+                {
+                    controller = "SimApiCommon",
+                    action = "Versions"
+                });
+        }
+
         if (options.EnableSimApiDoc)
         {
             logger.LogInformation("开始配置SimApiDoc...");
             var docOptions = options.SimApiDocOptions;
-            builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json").UseSwaggerUI(x =>
+            builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json")
+                .UseSwaggerUI(x =>
                 {
                     x.DocumentTitle = docOptions.DocumentTitle;
                     foreach (var group in docOptions.ApiGroups)