fix default option, add option description

.github/workflows/main.yml

@@ -1,34 +0,0 @@
-name: CI
-
-on: [create]
-
-jobs:
-  build:
-    name: Build Project
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Setup .NET Core
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '3.1.101'
-    - name: Build
-      run: dotnet build
-  
-  publish:
-    needs: build
-    name: Publish Project to Nuget
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Setup .NET Core
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '3.1.101'
-    - name: Publish
-      run: |
-        version=`git describe --tags`
-        dotnet pack --configuration release -p:PackageVersion=$version
-        dotnet nuget push bin/release/simcu.simapi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
-      env:
-        APIKEY: ${{ secrets.APPKEY }}

.github/workflows/nuget-publish.yml

@@ -0,0 +1,24 @@
+name: PublishNugetPackage
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  publish:
+    name: Publish Project to Nuget
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup .NET Core
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: "6.0.100"
+      - name: Publish
+        run: |
+          version=`git describe --tags`
+          dotnet build --configuration release -p:PackageVersion=$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/SimApiAuthAttribute.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using SimApi.Communications;
 using SimApi.Exceptions;
@@ -14,6 +15,7 @@ namespace SimApi.Attributes
     {
         private string[] Types { get; }
 
+
         //默认是user登录类型
         public SimApiAuthAttribute()
         {
@@ -32,6 +34,13 @@ namespace SimApi.Attributes
             Types = types;
         }
 
+        //只检测一种用户类型的快捷方式
+        public SimApiAuthAttribute(string type, string url)
+        {
+            Types = new[] { type };
+            new HttpPostAttribute(url);
+        }
+
         public override void OnActionExecuting(ActionExecutingContext context)
         {
             var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"];

Communications/SimApiBaseRequest.cs

@@ -1,4 +1,5 @@
 using System;
+
 namespace SimApi.Communications
 {
     /// <summary>
@@ -9,12 +10,30 @@ namespace SimApi.Communications
         public int Id { get; set; }
     }
 
+    /// <summary>
+    /// 只有ID的请求(字符串)
+    /// </summary>
+    public class SimApiStringIdOnlyRequest
+    {
+        public string Id { get; set; }
+    }
+
+    /// <summary>
+    /// 动态类型单字段请求
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    public class SimApiOneFieldRequest<T>
+    {
+        public T Data { get; set; }
+    }
+
     /// <summary>
     /// 基础分页请求
     /// </summary>
     public class SimApiBasePageRequest
     {
         public int Page { get; set; }
+
         public int Count { get; set; }
     }
 }

Communications/SimApiBaseResponse.cs

@@ -95,7 +95,7 @@ namespace SimApi.Communications
             {
                 IgnoreReadOnlyProperties = true,
                 PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-                Converters = { new JsonStringEnumConverter() }
+                Converters = {new JsonStringEnumConverter()}
             });
         }
     }
@@ -110,10 +110,13 @@ namespace SimApi.Communications
         /// 动态内容列表
         /// </summary>
         public T List { get; set; }
+
         //当前页码
         public int Page { get; set; }
+
         //每页条数
         public int Count { get; set; }
+
         //总计条数
         public int Total { get; set; }
     }

Communications/SimApiLoginItem.cs

@@ -1,4 +1,5 @@
 using System;
+
 namespace SimApi.Communications
 {
     /// <summary>
@@ -7,7 +8,8 @@ namespace SimApi.Communications
     public class SimApiLoginItem
     {
         //登录用户的ID
-        public int Id { get; set; }
+        public string Id { get; set; }
+
         //登录用户来源
         public string[] Type { get; set; }
     }

Configurations/SimApiDocOptions.cs

@@ -0,0 +1,73 @@
+using System;
+using System.Collections.Generic;
+using Swashbuckle.AspNetCore.SwaggerUI;
+
+namespace SimApi.Configs
+{
+    /// <summary>
+    /// 文档组配置
+    /// </summary>
+    public class SimApiDocGroupOption
+    {
+        /// <summary>
+        /// 文档标识
+        /// </summary>
+        public string Id { get; set; }
+
+        /// <summary>
+        /// 文档名称
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// 文档描述
+        /// </summary>
+        public string Description { get; set; }
+    }
+
+    /// <summary>
+    /// 授权配置, Type支持 "SimApiAuth","ClientCredentials","Implicit","AuthorizationCode"
+    /// </summary>
+    public class SimApiAuthOption
+    {
+        public string[] Type { get; set; } = new[] {"SimApiAuth"};
+        public string Description { get; set; } = "认证服务器颁发的AccessToken";
+        public string AuthorizationUrl { get; set; }
+        public string TokenUrl { get; set; }
+        public Dictionary<string, string> Scopes { get; set; }
+    }
+
+    /// <summary>
+    /// 文档配置
+    /// </summary>
+    public class SimApiDocOptions
+    {
+        /// <summary>
+        /// 文档组配置
+        /// </summary>
+        public SimApiDocGroupOption[] ApiGroups { get; set; } = new[]
+        {
+            new SimApiDocGroupOption
+            {
+                Id = "api",
+                Name = "Api",
+                Description = "Api接口文档"
+            }
+        };
+
+        /// <summary>
+        /// 授权配置
+        /// </summary>
+        public SimApiAuthOption ApiAuth { get; set; } = new SimApiAuthOption();
+
+        /// <summary>
+        /// 文档页面标题
+        /// </summary>
+        public string DocumentTitle { get; set; } = "API接口文档";
+        
+        /// <summary>
+        /// 接口支持的调用方式
+        /// </summary>
+        public SubmitMethod[] SupportedMethod { get; set; } = new[] {SubmitMethod.Post};
+    }
+}

Configurations/SimApiOptions.cs

@@ -0,0 +1,76 @@
+using System;
+
+namespace SimApi.Configs
+{
+    public class SimApiOptions
+    {
+        /// <summary>
+        /// 启用全部Cors，对于开发前后分离的时候很有用。
+        /// default: true
+        /// </summary>
+        public bool EnableCors { get; set; } = true;
+
+        /// <summary>
+        /// 启用SimapiAuth，一个简单的基于Header Token的认证方式。
+        /// default: false
+        /// </summary>
+        public bool EnableSimApiAuth { get; set; } = false;
+
+        /// <summary>
+        /// 启用在线文档，启用后 访问 /swagger 可以查看对应的api文档。
+        /// default: false
+        /// </summary>
+        public bool EnableSimApiDoc { get; set; } = false;
+
+        /// <summary>
+        /// 启用异常拦截,启用后，所有的异常将被通过json反馈。
+        /// default: true
+        /// </summary>
+        public bool EnableSimApiException { get; set; } = true;
+
+        /// <summary>
+        /// 开启S3兼容的存储系统。
+        /// default: false
+        /// </summary>
+        public bool EnableSimApiStorage { get; set; } = false;
+
+        /// <summary>
+        /// 开启ForwardHeaders,开启后可以透传负载均衡的Headers
+        /// default: true
+        /// </summary>
+        public bool EnableForwardHeaders { get; set; } = true;
+
+        /// <summary>
+        /// 将所有的url都格式化为小写字母
+        /// default: true
+        /// </summary>
+        public bool EnableLowerUrl { get; set; } = true;
+
+        /// <summary>
+        /// 启用格式化的 Console Logger
+        /// default: false
+        /// </summary>
+        public bool EnableLogger { get; set; } = false;
+
+        /// <summary>
+        /// Swagger文档相关配置，需要启用 EnableSimApiDoc
+        /// </summary>
+        public SimApiDocOptions SimApiDocOptions { get; set; } = new SimApiDocOptions();
+
+        /// <summary>
+        /// S3兼容的存储系统配置，需要启用 EnableSimApiStorage
+        /// </summary>
+        public SimApiStorageOptions SimApiStorageOptions { get; set; } = new SimApiStorageOptions();
+
+
+        public void ConfigureSimApiDoc(Action<SimApiDocOptions> options = null)
+        {
+            options?.Invoke(SimApiDocOptions);
+        }
+
+        public void ConfigureSimApiStorage(Action<SimApiStorageOptions> options = null)
+        {
+            options?.Invoke(SimApiStorageOptions);
+        }
+    }
+}

Configurations/SimApiStorageOptions.cs

@@ -0,0 +1,24 @@
+namespace SimApi.Configs
+{
+    public class SimApiStorageOptions
+    {
+        /// <summary>
+        /// S3 服务器入口地址
+        /// </summary>
+        public string Endpoint { get; set; }
+
+        /// <summary>
+        /// S3 服务器文件访问地址
+        /// </summary>
+        public string ServeUrl { get; set; }
+
+        /// <summary>
+        /// S3服务 Bucket
+        /// </summary>
+        public string Bucket { get; set; }
+
+        public string AccessKey { get; set; }
+
+        public string SecretKey { get; set; }
+    }
+}

Controllers/SimApiBaseController.cs

@@ -72,7 +72,7 @@ namespace SimApi.Controllers
         /// <param name="condition">检测条件</param>
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述</param>
-        protected static void ErrorWhenNull(object condition, int code = 404, string message = "请求的资源不存在")
+        protected static void ErrorWhenNull(object condition, int code = 404, string message = "")
         {
             ErrorWhen(condition == null, code, message);
         }
@@ -85,7 +85,5 @@ namespace SimApi.Controllers
         {
             return new SimApiBaseResponse<string>();
         }
-
-
     }
 }

Controllers/SimApiCommonController.cs

@@ -6,6 +6,7 @@ using SimApi.Helpers;
 
 namespace SimApi.Controllers
 {
+    [ApiExplorerSettings(GroupName = "api")]
     public class YYCommonController : SimApiBaseController
     {
         private SimApiAuth Auth { get; }
@@ -34,10 +35,13 @@ namespace SimApi.Controllers
         /// </summary>
         /// <returns></returns>
         [HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")]
-        public SimApiBaseResponse<int> CheckLogin()
+        public SimApiBaseResponse<string> CheckLogin()
         {
             ErrorWhenNull(LoginInfo, 401);
-            return new SimApiBaseResponse<int> { Data = LoginInfo.Id };
+            return new SimApiBaseResponse<string>
+            {
+                Data = LoginInfo.Id
+            };
         }
 
         /// <summary>
@@ -53,6 +57,7 @@ namespace SimApi.Controllers
             {
                 token = Request.Headers["Token"];
             }
+
             Auth.Logout(token);
             return new SimApiBaseResponse();
         }

Helpers/SimApiAuth.cs

@@ -23,7 +23,7 @@ namespace SimApi.Helpers
         /// </summary>
         /// <param name="id"></param>
         /// <returns></returns>
-        public string Login(int id, string type = "user", string token = null)
+        public string Login(string id, string type = "user", string token = null)
         {
             return Login(id, new[] { type }, token);
         }
@@ -34,7 +34,7 @@ namespace SimApi.Helpers
         /// <param name="id"></param>
         /// <param name="type"></param>
         /// <returns></returns>
-        public string Login(int id, string[] type, string uuid = null)
+        public string Login(string id, string[] type, string uuid = null)
         {
             if (uuid == null)
             {
@@ -55,7 +55,10 @@ namespace SimApi.Helpers
         /// <param name="uuid">登陆标识</param>
         public void Logout(string uuid)
         {
-            Cache.Remove(uuid);
+            if (!string.IsNullOrEmpty(uuid))
+            {
+                Cache.Remove(uuid);
+            }
         }
 
     }

Helpers/SimApiStorage.cs

@@ -0,0 +1,100 @@
+using System;
+using System.IO;
+using Microsoft.AspNetCore.Http;
+using Minio;
+using Minio.Exceptions;
+using SimApi.Configs;
+
+namespace SimApi.Helpers
+{
+    public class SimApiStorage
+    {
+        private MinioClient Mc { get; }
+
+        public MinioClient Client => Mc;
+
+        private string ServeUrl { get; }
+
+        private string Bucket { get; }
+
+        private IHttpContextAccessor HttpContextAccessor { get; }
+
+        public SimApiStorage(SimApiOptions apiOptions, IHttpContextAccessor httpContextAccessor)
+        {
+            var options = apiOptions.SimApiStorageOptions;
+            HttpContextAccessor = httpContextAccessor;
+            var useSsl = false;
+            string endpoint;
+            if (options.Endpoint.StartsWith("http://"))
+            {
+                endpoint = options.Endpoint.Replace("http://", string.Empty);
+            }
+            else if (options.Endpoint.StartsWith("https://"))
+            {
+                endpoint = options.Endpoint.Replace("https://", string.Empty);
+                useSsl = true;
+            }
+            else
+            {
+                throw new Exception("SimApiStorage: Error Endpoint");
+            }
+
+            ServeUrl = options.ServeUrl;
+            Bucket = options.Bucket;
+            var mcb = new MinioClient().WithEndpoint(endpoint)
+                .WithCredentials(options.AccessKey, options.SecretKey);
+            if (useSsl)
+            {
+                mcb = mcb.WithSSL();
+            }
+            Mc = mcb.Build();
+
+            bool found = Mc.BucketExistsAsync(new BucketExistsArgs().WithBucket(Bucket)).Result;
+            if (!found)
+            {
+                Mc.MakeBucketAsync(new MakeBucketArgs().WithBucket(Bucket)).Wait();
+            }
+        }
+
+        public string GetUploadUrl(string path, int expire = 7200)
+        {
+            try
+            {
+                return Mc.PresignedPutObjectAsync(new PresignedPutObjectArgs().WithBucket(Bucket)
+                    .WithObject(path).WithExpiry(expire)).Result;
+            }
+            catch (MinioException e)
+            {
+                Console.WriteLine("Error occurred: " + e);
+                return e.Message;
+            }
+        }
+
+        public string UploadFile(string path, Stream stream,string contentType = "image/png")
+        {
+            try
+            {
+                Mc.PutObjectAsync(new PutObjectArgs().WithBucket(Bucket).WithObject(path).
+                    WithObjectSize(stream.Length).WithStreamData(stream).WithContentType(contentType)).Wait();
+                return null;
+            }
+            catch (MinioException e)
+            {
+                Console.WriteLine("Error occurred: " + e);
+                return e.Message;
+            }
+        }
+
+        public string FullUrl(string path)
+        {
+            var httpRequest = HttpContextAccessor.HttpContext?.Request;
+            var url = $"{httpRequest?.Scheme}://{httpRequest?.Host}";
+            if (string.IsNullOrEmpty(path))
+            {
+                return path;
+            }
+
+            return path.StartsWith("~") ? url + path.Substring(1, path.Length - 1) : $"{ServeUrl}{path}";
+        }
+    }
+}

Helpers/SimApiUpload.cs

@@ -1,103 +0,0 @@
-using System;
-using System.IO;
-using Microsoft.AspNetCore.Hosting;
-
-namespace SimApi.Helpers
-{
-    public class SimApiUpload
-    {
-        private string FilePathFolder = "/uploads/";
-        public string FilePath
-        {
-            set
-            {
-                if (!value.StartsWith("/"))
-                {
-                    FilePathFolder = $"/{value}";
-                }
-                if (!FilePathFolder.EndsWith("/"))
-                {
-                    FilePathFolder += "/";
-                }
-            }
-            get
-            {
-                return FilePathFolder;
-            }
-        }
-
-        private IWebHostEnvironment Env { get; }
-
-        public SimApiUpload(IWebHostEnvironment env)
-        {
-            Env = env;
-        }
-
-        public class SimApiUploadInfo
-        {
-            public string Path { get; set; }
-            public int Size { get; set; }
-        }
-
-        /// <summary>
-        /// 保存base64文件,如果有标头按照标头自动识别
-        /// </summary>
-        /// <param name="base64"></param>
-        /// <param name="ext">扩展名</param>
-        /// <param name="path">存放路径</param>
-        /// <param name="fileName">文件名</param>
-        /// <returns></returns>
-        public SimApiUploadInfo SaveFile(string base64, string ext = null, string path = null, string fileName = null)
-        {
-            byte[] bt;
-            var filePath = FilePath + path;
-            if (fileName == null)
-            {
-                fileName = Guid.NewGuid().ToString();
-            }
-            var baseArr = base64.Split(";");
-            if (baseArr.Length == 2)
-            {
-                var info = baseArr[0].Split(":")[1].Split("/");
-                if (path == null)
-                {
-                    filePath += $"{info[0]}/";
-                }
-                if (ext == null)
-                {
-                    ext = info[1];
-                }
-                var data = baseArr[1].Split(",");
-                bt = Convert.FromBase64String(data[1]);
-            }
-            else
-            {
-                bt = Convert.FromBase64String(base64);
-            }
-            var fn = fileName + (string.IsNullOrEmpty(ext) ? string.Empty : $".{ext}");
-            return WriteFile(filePath, fn, bt);
-        }
-
-        /// <summary>
-        /// 把数据写入文件
-        /// </summary>
-        /// <param name="filePath"></param>
-        /// <param name="fileName"></param>
-        /// <param name="data"></param>
-        /// <returns></returns>
-        public SimApiUploadInfo WriteFile(string filePath, string fileName, byte[] data)
-        {
-            var realPath = Directory.GetCurrentDirectory() + "/wwwroot" + filePath;
-            if (!Directory.Exists(realPath))
-            {
-                Directory.CreateDirectory(realPath);
-            }
-            File.WriteAllBytes(realPath + fileName, data);
-            return new SimApiUploadInfo
-            {
-                Path = filePath + fileName,
-                Size = data.Length
-            };
-        }
-    }
-}

Helpers/SimApiUtil.cs

@@ -1,12 +1,31 @@
 using System;
 using System.Security.Cryptography;
 using System.Text;
+using System.Text.Encodings.Web;
+using System.Text.Json;
 using System.Text.RegularExpressions;
+using System.Text.Unicode;
 
-namespace SimApiApi.Helpers
+namespace SimApi.Helpers
 {
     public static class SimApiUtil
     {
+        /// <summary>
+        /// 当前CST时间
+        /// </summary>
+        public static DateTime CstNow
+        {
+            get => DateTime.UtcNow.AddHours(8);
+        }
+
+        /// <summary>
+        /// 当前秒级时间戳
+        /// </summary>
+        public static double TimestampNow
+        {
+            get => (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0)).TotalSeconds;
+        }
+
         /// <summary>
         /// 检测手机号是否正确
         /// </summary>
@@ -14,7 +33,7 @@ namespace SimApiApi.Helpers
         /// <returns></returns>
         public static bool CheckCell(string cell)
         {
-            var regex = new Regex("^1[34578]\\d{9}$");
+            var regex = new Regex("^1[3456789]\\d{9}$");
             return regex.IsMatch(cell);
         }
 
@@ -37,5 +56,18 @@ namespace SimApiApi.Helpers
 
             return strbul.ToString();
         }
+
+        /// <summary>
+        /// 将对象序列化成JSON （控制台输出中文不会被编码）
+        /// </summary>
+        /// <param name="obj"></param>
+        /// <returns></returns>
+        public static string Json(object obj)
+        {
+            return JsonSerializer.Serialize(obj, new JsonSerializerOptions
+            {
+                Encoder = JavaScriptEncoder.Create(UnicodeRanges.All)
+            });
+        }
     }
 }

Logger/SimApiLogger.cs

@@ -0,0 +1,45 @@
+using System;
+using Microsoft.Extensions.Logging;
+using SimApi.Helpers;
+
+namespace SimApi.Logger
+{
+    public class SimApiLogger : ILogger
+    {
+        private string Name { get; }
+
+        public SimApiLogger(string name)
+        {
+            Name = name;
+        }
+
+        public IDisposable BeginScope<TState>(TState state) => default!;
+
+        public bool IsEnabled(LogLevel logLevel) => true;
+
+        public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception,
+            Func<TState, Exception, string> formatter)
+        {
+            var defautColor = Console.ForegroundColor;
+            Console.ForegroundColor = logLevel switch
+            {
+                LogLevel.Debug => ConsoleColor.DarkMagenta,
+                LogLevel.Information => ConsoleColor.DarkCyan,
+                LogLevel.Warning => ConsoleColor.Yellow,
+                LogLevel.Error => ConsoleColor.Red,
+                LogLevel.Critical => ConsoleColor.DarkRed,
+                _ => defautColor
+            };
+            Console.WriteLine(
+                $"[ {Name} ][ {SimApiUtil.CstNow.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]");
+            Console.ForegroundColor = defautColor;
+            Console.WriteLine($"{state}");
+            if (exception != null)
+            {
+                Console.WriteLine($"{exception}");
+            }
+
+            Console.WriteLine();
+        }
+    }
+}

Logger/SimApiLoggerConfiguration.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using Microsoft.Extensions.Logging;
+
+namespace SimApi.Logger;
+
+public class SimApiLoggerConfiguration
+{
+    public int EventId { get; set; }
+
+    public Dictionary<LogLevel, ConsoleColor> LogLevels { get; set; } = new()
+    {
+        [LogLevel.Information] = ConsoleColor.Green
+    };
+}

Logger/SimApiLoggerProvider.cs

@@ -0,0 +1,22 @@
+using System.Collections.Concurrent;
+using Microsoft.Extensions.Logging;
+
+namespace SimApi.Logger
+{
+    public class SimApiLoggerProvider : ILoggerProvider
+    {
+        private readonly ConcurrentDictionary<string, SimApiLogger> _loggers =
+            new ConcurrentDictionary<string, SimApiLogger>();
+
+
+        public ILogger CreateLogger(string categoryName)
+        {
+            return _loggers.GetOrAdd(categoryName, name => new SimApiLogger(name));
+        }
+
+        public void Dispose()
+        {
+            _loggers.Clear();
+        }
+    }
+}

Middlewares/SimApiExceptionMiddleware.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 using SimApi.Communications;
@@ -23,14 +24,34 @@ namespace SimApi.Middlewares
 
         public async Task InvokeAsync(HttpContext context)
         {
+            if (context.Request.Headers.ContainsKey("Query-Id"))
+            {
+                context.Response.Headers["Query-Id"] = context.Request.Headers["Query-Id"];
+            }
+
             var response = new SimApiBaseResponse();
             try
             {
                 await Next(context);
+                if (context.Response.StatusCode != 200)
+                {
+                    if (!new[] {301, 302}.Contains(context.Response.StatusCode))
+                    {
+                        throw new SimApiException(context.Response.StatusCode);
+                    }
+                }
             }
             catch (SimApiException ex)
             {
-                response.SetCodeMsg(ex.Code, ex.Message);
+                if (string.IsNullOrEmpty(ex.Message))
+                {
+                    response.SetCode(ex.Code);
+                }
+                else
+                {
+                    response.SetCodeMsg(ex.Code, ex.Message);
+                }
+
                 ErrorResponse(context, response);
             }
             catch (Exception ex)

Models/SimApiBaseModel.cs

@@ -0,0 +1,90 @@
+using System;
+using System.Linq;
+using System.Text.Json;
+using SimApi.Helpers;
+
+namespace SimApi.Models
+{
+    public class SimApiBaseModel
+    {
+        protected virtual string[] MapperIgnoreField { get; set; } =
+        {
+            "Id", "CreatedAt", "UpdatedAt"
+        };
+
+        protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt";
+
+        public void MapData<TS>(TS source, bool mapAll = false)
+        {
+            //获取要赋值的源数据不为null的项目
+            var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
+                .Select(x => new
+                {
+                    x.Name,
+                    x.PropertyType
+                })
+                .ToDictionary(x => x.Name, x => x.PropertyType);
+
+            //获取目标对象的属性信息
+            var targetProps = GetType().GetProperties().Select(x => new
+                {
+                    x.Name,
+                    x.PropertyType
+                })
+                .ToDictionary(x => x.Name, x => x.PropertyType);
+            foreach (var sp in sourceProps)
+            {
+                //检查源对象不为空的属性是否在目标对象中存在
+                if (targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
+                    (!MapperIgnoreField.Contains(sp.Key) || mapAll))
+                {
+                    GetType().GetProperty(sp.Key)?
+                        .SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
+                }
+            }
+
+            UpdateTime();
+        }
+
+        public void MapData<TS>(TS source, string[] mapFields)
+        {
+            //获取要赋值的源数据不为null的项目
+            var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
+                .Select(x => new
+                {
+                    x.Name,
+                    x.PropertyType
+                })
+                .ToDictionary(x => x.Name, x => x.PropertyType);
+
+            //获取目标对象的属性信息
+            var targetProps = GetType().GetProperties().Select(x => new
+                {
+                    x.Name,
+                    x.PropertyType
+                })
+                .ToDictionary(x => x.Name, x => x.PropertyType);
+            foreach (var sp in sourceProps)
+            {
+                //检查源对象不为空的属性是否在目标对象中存在
+                if (targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
+                    mapFields.Contains(sp.Key))
+                {
+                    GetType().GetProperty(sp.Key)?
+                        .SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
+                }
+            }
+
+            UpdateTime();
+        }
+
+        /// <summary>
+        /// 更新update时间
+        /// </summary>
+        /// <returns></returns>
+        public void UpdateTime()
+        {
+            GetType().GetProperty(UpdatedTimeField)?.SetValue(this, SimApiUtil.CstNow);
+        }
+    }
+}

Properties/launchSettings.json

@@ -4,7 +4,7 @@
     "anonymousAuthentication": true
   },
   "profiles": {
-    "YYApi": {
+    "SimApi": {
       "commandName": "Project",
       "launchBrowser": true,
       "environmentVariables": {

README.md

@@ -1,4 +1,4 @@
-# YYApi 基于Asp.net Core 3的一个基础辅助包
+# YYApi 基于Asp.net Core 3/5的一个基础辅助包
 
 ![CI](https://github.com/YY-Tech/YYApi/workflows/CI/badge.svg)
 
@@ -23,43 +23,33 @@ namespace Controllers
 }
 ```
 
-2. 基于Swagger的API文档服务
 
+统一配置，现在只需要进行AddSimApi的配置， Configure中直接 UseSimApi即可。
 ```C#
-#Startup.cs
+services.AddSimApi(options =>
-
+{
-	services.AddSimApiDoc("文档名称", "文档描述");
+   options.ConfigureSimApiDoc(options =>
-
+   {
-	app.UseSimApiDoc("名称",SubmitMethod[])
+     options.ApiGroups = new[]
-
+     {
-#控制器中可以直接使用特性
+        new SimApiDocGroupOption
-
+            {Id = "admin", Name = "后台管理接口", Description = "本接口调用需要Scope：sac.api.admin"},
-	[SimApiDoc("分组","名称")]
+        new SimApiDocGroupOption
-```
+            {Id = "user-v1", Name = "用户中心接口", Description = "本接口调用需要Scope：sac.api.user"}
-
+     };
-3. 简单的基于Redis的登录TOKEN服务
+     options.ApiAuth = new SimApiAuthOption
-
+       {
-```C#
+         Type = new[] {"ClientCredentials", "Implicit", "AuthorizationCode"},
-#Startup.cs
+         Scopes = new Dictionary<string, string>
-service.AddSimApiAuth();
+            {
-```
+              {"sac.api.user", "用户信息接口权限"},
-添加时候, 可以从DI中获取 Auth 类,调用 Auth.Set(int,string) 将用户ID/类型和生成的Token绑定,本方法返回缓存中的Key名称
+              {"sac.api.admin", "后台管理API"}
-
+            },
-```C#
+         AuthorizationUrl = "/connect/authorize",
-#Startup.cs
+         TokenUrl = "/connect/token"
-app.UseSimApiAuth();
+       };
-```
+     });
-调用本中间件,然后再需要登录认证的地方,使用 [YYAuth] 特性,即可完成检测登录相关的操作,
+     options.EnableSimApiStorage = true;
-如果需要获取用户的ID, 只需要 直接使用 LoginId 属性即可获取
+     options.SimApiStorageOptions = Configuration.GetSection("S3").Get<SimApiStorageOptions>();
-
+});
-4. 统一返回
-所有Response 均需要继承 SimApiBaseResponse类
-
-
-5. 异常处理
-本异常中间件封装了API错误的异常处理,控制器可以使用 Error(int,string) 直接返回API错误
-
-```C#
-#Startup.cs
-app.UseSimApiException();
 ```

SimApi.csproj

@@ -1,16 +1,20 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
     <OutputType>Library</OutputType>
     <PackOnBuild>true</PackOnBuild>
     <Version>0.2.3</Version>
     <Authors>xRain@SimcuTeam</Authors>
     <Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
-    <PackageId>simcu.simapi</PackageId>
+    <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>
+    <TargetFramework>net6.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
@@ -20,10 +24,12 @@
     <Folder Include="Middlewares\" />
     <Folder Include="Attributes\" />
     <Folder Include="Exceptions\" />
+    <Folder Include="Configurations\" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.5.1" />
+    <PackageReference Include="Minio" Version="4.0.4" />
-    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.5.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.3.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.3.1" />
   </ItemGroup>
   <ProjectExtensions>
     <MonoDevelop>

SimApiExtensions.cs

@@ -3,175 +3,256 @@ using SimApi.Helpers;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.OpenApi.Models;
-using Swashbuckle.AspNetCore.SwaggerUI;
 using SimApi.Middlewares;
+using Microsoft.AspNetCore.HttpOverrides;
+using Microsoft.Extensions.Logging;
+using SimApi.Configs;
+using SimApi.Logger;
 
 namespace SimApi
 {
     /// <summary>
     /// 加入系统的扩展信息
     /// </summary>
-    public static class Extensions
+    public static class SimApiExtensions
     {
         //**********快捷添加**************
-
+        public static IServiceCollection AddSimApi(this IServiceCollection builder,
-        /// <summary>
+            Action<SimApiOptions> options = null)
-        /// 添加整个SimApiAPI,同时增加CORS规则
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title"></param>
-        /// <param name="description"></param>
-        /// <returns></returns>
-        public static IServiceCollection AddSimApiApi(this IServiceCollection builder, string title,
-            string description = null)
         {
-            return builder.AddSimApiAuth().AddSimApiDoc(title, description).AddCors().AddSimApiUpload();
+            var simApiOptions = new SimApiOptions();
-        }
+            options?.Invoke(simApiOptions);
 
-        /// <summary>
+            // 是否使用 AUTH
-        ///  使用所有SimApiApi自定义中间件
+            if (simApiOptions.EnableSimApiAuth)
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title"></param>
-        /// <param name="staticFileroot"></param>
-        /// <param name="submitMethods"></param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseSimApiApi(this IApplicationBuilder builder, string title = "API文档", params SubmitMethod[] submitMethods)
-        {
-            return builder.UseSimApiException().UseSimApiDoc(title, submitMethods).UseMiddleware<SimApiAuthMiddleware>().UseCors(x => x.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin()).UseSimApiUpload();
-        }
-
-
-
-        //*********组件快捷方式*************
-
-        /// <summary>
-        /// 添加自定义授权认证中间价
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <returns></returns>
-        public static IServiceCollection AddSimApiAuth(this IServiceCollection builder)
-        {
-            return builder.AddScoped<SimApiAuth>();
-        }
-
-        /// <summary>
-        /// 添加Base64上传组件
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <returns></returns>
-        public static IServiceCollection AddSimApiUpload(this IServiceCollection builder)
-        {
-            return builder.AddSingleton<SimApiUpload>();
-        }
-
-        /// <summary>
-        /// 添加Api文档服务
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title">文档标题</param>
-        /// <param name="description">文档描述</param>
-        /// <returns></returns>
-        public static IServiceCollection AddSimApiDoc(this IServiceCollection builder, string title,
-            string description = null)
-        {
-            return builder.AddSwaggerGen(x =>
             {
-                x.SwaggerDoc("api", new OpenApiInfo { Title = title, Description = description });
+                builder.AddScoped<SimApiAuth>();
-                x.EnableAnnotations();
+            }
-                x.AddSecurityRequirement(new OpenApiSecurityRequirement
+
+            if (simApiOptions.EnableCors)
+            {
+                builder.AddCors(cors => cors.AddPolicy("any",
+                    policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); }));
+            }
+
+            // 使用SimApiDoc
+            if (simApiOptions.EnableSimApiDoc)
+            {
+                var docOptions = simApiOptions.SimApiDocOptions;
+                builder.AddSwaggerGen(x =>
                 {
+                    foreach (var group in docOptions.ApiGroups)
                     {
-                        new OpenApiSecurityScheme
+                        x.SwaggerDoc(group.Id, new OpenApiInfo
                         {
-                            Reference = new OpenApiReference {Type = ReferenceType.SecurityScheme, Id = "HeaderToken"}
+                            Title = group.Name,
-                        },
+                            Description = group.Description
-                        new[] {"readAccess", "writeAccess"}
+                        });
+                    }
+
+                    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
+                                {
+                                    {
+                                        new OpenApiSecurityScheme
+                                        {
+                                            Reference = new OpenApiReference
+                                            {
+                                                Type = ReferenceType.SecurityScheme,
+                                                Id = "HeaderToken"
+                                            }
+                                        },
+                                        new[]
+                                        {
+                                            "readAccess", "writeAccess"
+                                        }
+                                    }
+                                });
+                                haveSimApiAuth = true;
+                                break;
+                            case "ClientCredentials":
+                                oauthFlows.ClientCredentials = new OpenApiOAuthFlow
+                                {
+                                    TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
+                                    Scopes = docOptions.ApiAuth.Scopes
+                                };
+                                haveOauth = true;
+                                break;
+                            case "Implicit":
+                                oauthFlows.Implicit = new OpenApiOAuthFlow
+                                {
+                                    AuthorizationUrl = new Uri(docOptions.ApiAuth.AuthorizationUrl,
+                                        UriKind.RelativeOrAbsolute),
+                                    Scopes = docOptions.ApiAuth.Scopes
+                                };
+                                haveOauth = true;
+                                break;
+                            case "AuthorizationCode":
+                                oauthFlows.AuthorizationCode = new OpenApiOAuthFlow
+                                {
+                                    TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
+                                    AuthorizationUrl = new Uri(docOptions.ApiAuth.AuthorizationUrl,
+                                        UriKind.RelativeOrAbsolute),
+                                    Scopes = docOptions.ApiAuth.Scopes
+                                };
+                                haveOauth = true;
+                                break;
+                            case "Password":
+                                oauthFlows.Password = new OpenApiOAuthFlow
+                                {
+                                    TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
+                                    Scopes = docOptions.ApiAuth.Scopes
+                                };
+                                haveOauth = true;
+                                break;
+                        }
+                    }
+
+                    if (haveOauth)
+                    {
+                        x.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
+                        {
+                            Type = SecuritySchemeType.OAuth2,
+                            Flows = oauthFlows,
+                            Description = docOptions.ApiAuth.Description,
+                            In = ParameterLocation.Header
+                        });
+                        x.AddSecurityRequirement(new OpenApiSecurityRequirement
+                        {
+                            {
+                                new OpenApiSecurityScheme
+                                {
+                                    Reference = new OpenApiReference
+                                    {
+                                        Type = ReferenceType.SecurityScheme,
+                                        Id = "oauth2"
+                                    }
+                                },
+                                new[]
+                                {
+                                    "SimApiAuth"
+                                }
+                            }
+                        });
+                    }
+
+                    if (haveSimApiAuth)
+                    {
+                        x.AddSecurityDefinition("HeaderToken",
+                            new OpenApiSecurityScheme
+                            {
+                                Name = "Token",
+                                In = ParameterLocation.Header
+                            });
                     }
                 });
-                x.AddSecurityDefinition("HeaderToken",
+            }
-                    new OpenApiSecurityScheme { Name = "Token", In = ParameterLocation.Header });
-            });
-        }
 
-
+            // 使用Header转发，应对代理后获取真实ip
-        /// <summary>
+            if (simApiOptions.EnableForwardHeaders)
-        /// 使用异常中间价扩展
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseSimApiException(this IApplicationBuilder builder)
-        {
-            return builder.UseMiddleware<SimApiExceptionMiddleware>();
-        }
-
-        /// <summary>
-        /// 配置上传组件必须
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseSimApiUpload(this IApplicationBuilder builder)
-        {
-            return builder.UseStaticFiles(new StaticFileOptions
             {
-                DefaultContentType = "application/x-msdownload",
+                builder.Configure<ForwardedHeadersOptions>(fwOptions =>
-                ServeUnknownFileTypes = true
+                {
-            });
+                    fwOptions.ForwardedHeaders = ForwardedHeaders.All;
-        }
+                    fwOptions.KnownNetworks.Clear();
+                    fwOptions.KnownProxies.Clear();
+                });
+            }
 
-        /// <summary>
+            if (simApiOptions.EnableLowerUrl)
-        /// 使用文档UI
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title">文档标题</param>
-        /// <param name="submitMethods">文档支持的提交方式(如果不指定,默认使用POST)</param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseSimApiDoc(this IApplicationBuilder builder, string title,
-            params SubmitMethod[] submitMethods)
-        {
-            return builder.UseSwagger(x => x.RouteTemplate = "docs/{documentName}.json").UseSwaggerUI(x =>
             {
-                x.RoutePrefix = "docs";
+                builder.AddRouting(rOptions => rOptions.LowercaseUrls = true);
-                x.DocumentTitle = title;
+            }
-                x.SwaggerEndpoint("/docs/api.json", name: title);
-                x.EnableValidator();
-                if (submitMethods.Length > 0)
-                {
-                    x.SupportedSubmitMethods(submitMethods);
-                }
-                else
-                {
-                    x.SupportedSubmitMethods(SubmitMethod.Post);
-                }
 
-                x.DisplayRequestDuration();
+            if (simApiOptions.EnableSimApiStorage)
-            });
+            {
-        }
+                builder.AddHttpContextAccessor();
+                builder.AddSingleton<SimApiStorage>();
+            }
 
-
+            builder.AddSingleton(simApiOptions);
-        /// <summary>
+            return builder;
-        /// 同时使用Api文档和异常处理中间件
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title">文档标题</param>
-        /// <param name="submitMethods">API提交方式定义</param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseSimApiDocEx(this IApplicationBuilder builder, string title = "API文档",
-            params SubmitMethod[] submitMethods)
-        {
-            return builder.UseSimApiException().UseSimApiDoc(title, submitMethods);
         }
 
         /// <summary>
-        /// 使用自定义认证中间件（依赖IDistributedCache）
+        ///  使用所有SimApi自定义中间件
         /// </summary>
         /// <param name="builder"></param>
         /// <returns></returns>
-        public static IApplicationBuilder UseSimApiAuth(this IApplicationBuilder builder)
+        public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder)
         {
-            return builder.UseMiddleware<SimApiAuthMiddleware>();
+            var options = builder.ApplicationServices.GetRequiredService<SimApiOptions>();
+            if (options.EnableLogger)
+            {
+                builder.ApplicationServices.GetRequiredService<ILoggerFactory>()
+                    .AddProvider(new SimApiLoggerProvider());
+            }
+
+            var logger = builder.ApplicationServices.GetRequiredService<ILogger<SimApiLogger>>();
+
+            if (options.EnableForwardHeaders)
+            {
+                logger.LogInformation("开始配置ForwardedHeaders...");
+                builder.UseForwardedHeaders();
+            }
+
+            if (options.EnableCors)
+            {
+                logger.LogInformation("开始配置Cors全部允许...");
+                builder.UseCors("any");
+            }
+
+            if (options.EnableSimApiAuth)
+            {
+                logger.LogInformation("开始配置SimApiAuth...");
+                builder.UseMiddleware<SimApiAuthMiddleware>();
+            }
+
+            if (options.EnableSimApiDoc)
+            {
+                logger.LogInformation("开始配置SimApiDoc...");
+                var docOptions = options.SimApiDocOptions;
+                builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json").UseSwaggerUI(x =>
+                {
+                    x.DocumentTitle = docOptions.DocumentTitle;
+                    foreach (var group in docOptions.ApiGroups)
+                    {
+                        x.SwaggerEndpoint($"/swagger/{group.Id}.json", name: group.Name);
+                    }
+
+                    x.EnableValidator();
+                    x.SupportedSubmitMethods(docOptions.SupportedMethod);
+                    x.DisplayRequestDuration();
+                });
+            }
+
+            if (options.EnableSimApiException)
+            {
+                logger.LogInformation("开始配置SimApiException...");
+                builder.UseMiddleware<SimApiExceptionMiddleware>();
+            }
+
+            //请求一下检测存储错误
+            if (options.EnableSimApiStorage)
+            {
+                logger.LogInformation("开始配置SimApiStorage...");
+                builder.ApplicationServices.GetService<SimApiStorage>();
+            }
+
+            if (options.EnableLowerUrl)
+            {
+                logger.LogInformation("开始配置使用URL小写...");
+            }
+
+            return builder;
         }
-
-
     }
 }