update to .net6

.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/YY-Tech.YYApi.$version.nupkg -k ${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: '5.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

@@ -0,0 +1,59 @@
+using System;
+using System.Linq;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Filters;
+using SimApi.Communications;
+using SimApi.Exceptions;
+
+namespace SimApi.Attributes
+{
+    /// <summary>
+    /// 检测登录中间件
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
+    public class SimApiAuthAttribute : ActionFilterAttribute
+    {
+        private string[] Types { get; }
+
+
+        //默认是user登录类型
+        public SimApiAuthAttribute()
+        {
+            Types = new[] { "user" };
+        }
+
+        //只检测一种用户类型的快捷方式
+        public SimApiAuthAttribute(string type)
+        {
+            Types = new[] { type };
+        }
+
+        //设定特定类型的检测
+        public SimApiAuthAttribute(string[] types)
+        {
+            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"];
+            //检测是否登录
+            if (loginInfo == null)
+            {
+                throw new SimApiException(401);
+            }
+            //检测用户类型
+            if (Types.Intersect(loginInfo.Type).Count() == 0)
+            {
+                throw new SimApiException(403);
+            }
+        }
+    }
+}

Attributes/SimApiDocAttribute.cs

@@ -1,20 +1,22 @@
-using Swashbuckle.AspNetCore.Annotations;
+using System;
+using Swashbuckle.AspNetCore.Annotations;
 
-namespace YYApi.Helpers
+namespace SimApi.Attributes
 {
     /// <summary>
     /// 快捷自定义接口文档类
     /// </summary>
-    public class ApiDoc : SwaggerOperationAttribute
+    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
+    public class SimApiDocAttribute : SwaggerOperationAttribute
     {
         /// <summary>
         /// 定义接口说明
         /// </summary>
         /// <param name="tag">接口分组</param>
         /// <param name="name">接口名称</param>
-        public ApiDoc(string tag, string name)
+        public SimApiDocAttribute(string tag, string name)
         {
-            Tags = new[] {tag};
+            Tags = new[] { tag };
             Summary = name;
             // Consumes = new[] {"application/json"};
             // Produces = new[] {"application/json"};

Communications/SimApiBaseRequest.cs

@@ -0,0 +1,30 @@
+using System;
+
+namespace SimApi.Communications
+{
+    /// <summary>
+    /// 只有ID的请求
+    /// </summary>
+    public class SimApiIdOnlyRequest
+    {
+        public int 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

@@ -2,12 +2,12 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
-namespace YYApi.Communications
+namespace SimApi.Communications
 {
     /// <summary>
     /// 基础相应
     /// </summary>
-    public class BaseResponse
+    public class SimApiBaseResponse
     {
         /// <summary>
         /// 错误代码
@@ -36,7 +36,7 @@ namespace YYApi.Communications
         /// <summary>
         /// 返回一个成功的空结果
         /// </summary>
-        public BaseResponse()
+        public SimApiBaseResponse()
         {
             SetCode(200);
         }
@@ -46,7 +46,7 @@ namespace YYApi.Communications
         /// 返回指定代码的描述
         /// </summary>
         /// <param name="code">错误代码</param>
-        public BaseResponse(int code)
+        public SimApiBaseResponse(int code)
         {
             SetCode(code);
         }
@@ -56,7 +56,7 @@ namespace YYApi.Communications
         /// </summary>
         /// <param name="code">错误代码</param>
         /// <param name="message">错误信息</param>
-        public BaseResponse(int code, string message)
+        public SimApiBaseResponse(int code, string message)
         {
             SetCodeMsg(code, message);
         }
@@ -95,7 +95,7 @@ namespace YYApi.Communications
             {
                 IgnoreReadOnlyProperties = true,
                 PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-                Converters = { new JsonStringEnumConverter() }
+                Converters = {new JsonStringEnumConverter()}
             });
         }
     }
@@ -104,16 +104,19 @@ namespace YYApi.Communications
     /// 动态内容分页
     /// </summary>
     /// <typeparam name="T"></typeparam>
-    public class BasePageResponse<T> : BaseResponse
+    public class SimApiBasePageResponse<T> : SimApiBaseResponse
     {
         /// <summary>
         /// 动态内容列表
         /// </summary>
         public T List { get; set; }
+
         //当前页码
         public int Page { get; set; }
+
         //每页条数
         public int Count { get; set; }
+
         //总计条数
         public int Total { get; set; }
     }
@@ -122,31 +125,11 @@ namespace YYApi.Communications
     /// 动态Data返回
     /// </summary>
     /// <typeparam name="T"></typeparam>
-    public class BaseResponse<T> : BaseResponse
+    public class SimApiBaseResponse<T> : SimApiBaseResponse
     {
         /// <summary>
         /// 动态内容列表
         /// </summary>
         public T Data { get; set; }
     }
-
-
-    //===========》请求《===============
-
-    /// <summary>
-    /// 只有ID的请求
-    /// </summary>
-    public class IdOnlyRequest
-    {
-        public int Id { get; set; }
-    }
-
-    /// <summary>
-    /// 基础分页请求
-    /// </summary>
-    public class BasePageRequest
-    {
-        public int Page { get; set; }
-        public int Count { get; set; }
-    }
 }

Communications/SimApiLoginItem.cs

@@ -0,0 +1,14 @@
+using System;
+namespace SimApi.Communications
+{
+    /// <summary>
+    /// 登录信息中间件
+    /// </summary>
+    public class SimApiLoginItem
+    {
+        //登录用户的ID
+        public int 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,29 @@
+using System;
+
+namespace SimApi.Configs
+{
+    public class SimApiOptions
+    {
+        public bool EnableCors { get; set; } = true;
+        public bool EnableSimApiAuth { get; set; } = false;
+        public bool EnableSimApiDoc { get; set; } = true;
+        public bool EnableSimApiException { get; set; } = true;
+        public bool EnableSimApiStorage { get; set; } = false;
+        public bool EnableForwardHeaders { get; set; } = true;
+        public bool EnableLowerUrl { get; set; } = true;
+        public bool EnableLogger { get; set; } = true;
+        public SimApiDocOptions SimApiDocOptions { get; set; } = new SimApiDocOptions();
+        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,11 @@
+namespace SimApi.Configs
+{
+    public class SimApiStorageOptions
+    {
+        public string Endpoint { get; set; }
+        public string ServeUrl { get; set; }
+        public string Bucket { get; set; }
+        public string AccessKey { get; set; }
+        public string SecretKey { get; set; }
+    }
+}

Controllers/SimApiBaseController.cs

@@ -1,11 +1,12 @@
-using YYApi.Communications;
-using YYApi.Helpers;
+using SimApi.Communications;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.AspNetCore.Mvc.ModelBinding;
 using System.Linq;
+using SimApi.Exceptions;
+using SimApi.Attributes;
 
-namespace YYApi.Controllers
+namespace SimApi.Controllers
 {
     /// <summary>
     /// 基础控制器,所有控制器均继承本控制器
@@ -13,12 +14,12 @@ namespace YYApi.Controllers
     /// 2. 报错返回
     /// 3. 错误回馈页面
     /// </summary>
-    public class BaseController : Controller
+    public class SimApiBaseController : Controller
     {
         /// <summary>
         /// 当前登录用户的ID
         /// </summary>
-        protected LoginInfoItem LoginInfo => (LoginInfoItem)HttpContext.Items["LoginInfo"];
+        protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"];
 
         /// <summary>
         /// 验证请求参数
@@ -46,9 +47,9 @@ namespace YYApi.Controllers
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
         /// <returns></returns>
-        protected static void Error(int code, string message = "")
+        protected static void Error(int code = 500, string message = "")
         {
-            throw new ApiException(code, message);
+            throw new SimApiException(code, message);
         }
 
         /// <summary>
@@ -57,7 +58,7 @@ namespace YYApi.Controllers
         /// <param name="condition">检测条件</param>
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述</param>
-        protected static void ErrorWhen(bool condition, int code, string message = "")
+        protected static void ErrorWhen(bool condition, int code = 500, string message = "")
         {
             if (condition)
             {
@@ -71,28 +72,20 @@ namespace YYApi.Controllers
         /// <param name="condition">检测条件</param>
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述</param>
-        protected static void ErrorWhenNull(object condition, int code, string message = "")
+        protected static void ErrorWhenNull(object condition, int code = 404, string message = "")
         {
             ErrorWhen(condition == null, code, message);
         }
 
         /// <summary>
-        /// 错误回馈页面
+        /// 上传文件
         /// </summary>
-        /// <param name="code">错误代码</param>
         /// <returns></returns>
-        [HttpGet("exception/{code:int}")]
-        [ApiExplorerSettings(IgnoreApi = true)]
-        public BaseResponse ExceptionHandler(int code)
+        protected SimApiBaseResponse<string> UploadFile()
         {
-            var response = new BaseResponse();
-            response.SetCode(code);
-            return response;
+            return new SimApiBaseResponse<string>();
         }
 
-        protected BaseResponse<string> UploadFile()
-        {
-            return new BaseResponse<string>();
-        }
+
     }
 }

Controllers/SimApiCommonController.cs

@@ -0,0 +1,62 @@
+using System;
+using Microsoft.AspNetCore.Mvc;
+using SimApi.Attributes;
+using SimApi.Communications;
+using SimApi.Helpers;
+
+namespace SimApi.Controllers
+{
+    [ApiExplorerSettings(GroupName = "api")]
+    public class YYCommonController : SimApiBaseController
+    {
+        private SimApiAuth Auth { get; }
+
+        public YYCommonController(SimApiAuth auth)
+        {
+            Auth = auth;
+        }
+
+        /// <summary>
+        /// 错误回馈页面
+        /// </summary>
+        /// <param name="code">错误代码</param>
+        /// <returns></returns>
+        [HttpGet("exception/{code:int}")]
+        [ApiExplorerSettings(IgnoreApi = true)]
+        public SimApiBaseResponse ExceptionHandler(int code)
+        {
+            var response = new SimApiBaseResponse();
+            response.SetCode(code);
+            return response;
+        }
+
+        /// <summary>
+        /// 检测用户登陆的控制器
+        /// </summary>
+        /// <returns></returns>
+        [HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")]
+        public SimApiBaseResponse<int> CheckLogin()
+        {
+            ErrorWhenNull(LoginInfo, 401);
+            return new SimApiBaseResponse<int> {Data = LoginInfo.Id};
+        }
+
+        /// <summary>
+        /// 退出登陆
+        /// </summary>
+        /// <returns></returns>
+        [HttpPost("/auth/logout"), SimApiDoc("认证", "退出登陆")]
+        public SimApiBaseResponse Logout()
+        {
+            string token = null;
+
+            if (Request.Headers.ContainsKey("Token"))
+            {
+                token = Request.Headers["Token"];
+            }
+
+            Auth.Logout(token);
+            return new SimApiBaseResponse();
+        }
+    }
+}

Exceptions/SimApiException.cs

@@ -0,0 +1,16 @@
+using System;
+namespace SimApi.Exceptions
+{
+    /// <summary>
+    /// Api错误捕获异常
+    /// </summary>
+    public class SimApiException : Exception
+    {
+        public int Code { get; }
+
+        public SimApiException(int code, string message = "") : base(message)
+        {
+            Code = code;
+        }
+    }
+}

Extensions.cs

@@ -1,149 +0,0 @@
-using System;
-using YYApi.Helpers;
-using Microsoft.AspNetCore.Builder;
-using Microsoft.Extensions.DependencyInjection;
-using Microsoft.OpenApi.Models;
-using Swashbuckle.AspNetCore.SwaggerUI;
-
-namespace YYApi
-{
-    /// <summary>
-    /// 加入系统的扩展信息
-    /// </summary>
-    public static class Extensions
-    {
-        /// <summary>
-        /// 添加自定义授权认证中间价
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <returns></returns>
-        public static IServiceCollection AddAuth(this IServiceCollection builder)
-        {
-            return builder.AddScoped<Auth>();
-        }
-
-        /// <summary>
-        /// 添加整个YYAPI
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title"></param>
-        /// <param name="description"></param>
-        /// <returns></returns>
-        public static IServiceCollection AddYYApi(this IServiceCollection builder, string title,
-            string description = null)
-        {
-            return builder.AddAuth().AddApiDoc(title, description).AddCors();
-        }
-
-        /// <summary>
-        /// 添加Api文档服务
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title">文档标题</param>
-        /// <param name="description">文档描述</param>
-        /// <returns></returns>
-        public static IServiceCollection AddApiDoc(this IServiceCollection builder, string title,
-            string description = null)
-        {
-            return builder.AddSwaggerGen(x =>
-            {
-                x.SwaggerDoc("api", new OpenApiInfo { Title = title, Description = description });
-                x.EnableAnnotations();
-                x.AddSecurityRequirement(new OpenApiSecurityRequirement
-                {
-                    {
-                        new OpenApiSecurityScheme
-                        {
-                            Reference = new OpenApiReference {Type = ReferenceType.SecurityScheme, Id = "HeaderToken"}
-                        },
-                        new[] {"readAccess", "writeAccess"}
-                    }
-                });
-                x.AddSecurityDefinition("HeaderToken",
-                    new OpenApiSecurityScheme { Name = "Token", In = ParameterLocation.Header });
-            });
-        }
-
-
-        /// <summary>
-        /// 使用异常中间价扩展
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseExceptionMiddleware(this IApplicationBuilder builder)
-        {
-            return builder.UseMiddleware<ExceptionMiddleware>();
-        }
-
-        /// <summary>
-        /// 使用文档UI
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title">文档标题</param>
-        /// <param name="submitMethods">文档支持的提交方式(如果不指定,默认使用POST)</param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseApiDoc(this IApplicationBuilder builder, string title,
-            params SubmitMethod[] submitMethods)
-        {
-            return builder.UseSwagger(x => x.RouteTemplate = "docs/{documentName}.json").UseSwaggerUI(x =>
-            {
-                x.RoutePrefix = "docs";
-                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();
-            });
-        }
-
-
-        /// <summary>
-        /// 同时使用Api文档和异常处理中间件
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title">文档标题</param>
-        /// <param name="submitMethods">API提交方式定义</param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseDocAndException(this IApplicationBuilder builder, string title = "API文档",
-            params SubmitMethod[] submitMethods)
-        {
-            return builder.UseExceptionMiddleware().UseApiDoc(title, submitMethods);
-        }
-
-        /// <summary>
-        /// 使用自定义认证中间件（依赖IDistributedCache）
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseAuthMiddleware(this IApplicationBuilder builder)
-        {
-            return builder.UseMiddleware<AuthMiddleware>();
-        }
-
-        /// <summary>
-        /// 使用所有YYApi自定义中间件
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title"></param>
-        /// <param name="submitMethods"></param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseYYApiMiddleware(this IApplicationBuilder builder, string title = "API文档",
-            params SubmitMethod[] submitMethods)
-        {
-            return builder.UseExceptionMiddleware().UseApiDoc(title, submitMethods).UseMiddleware<AuthMiddleware>().UseCors(x =>
-            {
-                x.AllowAnyHeader();
-                x.AllowAnyMethod();
-                x.AllowAnyOrigin();
-            }); ;
-        }
-    }
-}

Helpers/AuthMiddleware.cs

@@ -1,130 +0,0 @@
-using System;
-using System.Linq;
-using System.Text.Json;
-using System.Threading.Tasks;
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Mvc.Filters;
-using Microsoft.Extensions.Caching.Distributed;
-
-namespace YYApi.Helpers
-{
-    /// <summary>
-    /// 认证信息获取中间件
-    /// </summary>
-    public class AuthMiddleware
-    {
-        private RequestDelegate Next { get; }
-
-        public AuthMiddleware(RequestDelegate next)
-        {
-            Next = next;
-        }
-
-        public Task Invoke(HttpContext httpContext, IDistributedCache cache)
-        {
-            string token = null;
-            if (httpContext.Request.Headers.ContainsKey("Token"))
-            {
-                token = httpContext.Request.Headers["Token"];
-            }
-
-            if (!string.IsNullOrEmpty(token))
-            {
-                var login = cache.GetString(token);
-                if (login != null)
-                {
-                    httpContext.Items.Add("LoginInfo", JsonSerializer.Deserialize<LoginInfoItem>(login));
-                }
-            }
-
-            return Next(httpContext);
-        }
-    }
-
-    /// <summary>
-    /// 登录信息中间件
-    /// </summary>
-    public class LoginInfoItem
-    {
-        //登录用户的ID
-        public int Id { get; set; }
-        //登录用户来源
-        public string Type { get; set; }
-    }
-
-    /// <summary>
-    /// 检测登录中间件
-    /// </summary>
-    public class CheckAuthAttribute : ActionFilterAttribute
-    {
-        private string[] Types { get; }
-
-        //默认是user登录类型
-        public CheckAuthAttribute()
-        {
-            Types = new[] { "user" };
-        }
-
-        //只检测一种用户类型的快捷方式
-        public CheckAuthAttribute(string type)
-        {
-            Types = new[] { type };
-        }
-
-        //设定特定类型的检测
-        public CheckAuthAttribute(string[] types)
-        {
-            Types = types;
-        }
-
-        public override void OnActionExecuting(ActionExecutingContext context)
-        {
-            var loginInfo = (LoginInfoItem)context.HttpContext.Items["LoginInfo"];
-            //检测是否登录
-            if (loginInfo == null)
-            {
-                throw new ApiException(401);
-            }
-            //检测用户类型
-            if (!Types.Contains(loginInfo.Type))
-            {
-                throw new ApiException(403);
-            }
-        }
-    }
-
-    /// <summary>
-    /// 认证助手
-    /// </summary>
-    public class Auth
-    {
-        private IDistributedCache Cache { get; }
-
-        public Auth(IDistributedCache cache)
-        {
-            Cache = cache;
-        }
-
-        /// <summary>
-        /// 产生一个Token记录并返回Token
-        /// </summary>
-        /// <param name="id"></param>
-        /// <returns></returns>
-        public string Set(int id, string type = "user")
-        {
-            var uuid = GetUUID();
-            var loginItem = new LoginInfoItem
-            {
-                Id = id,
-                Type = type
-            };
-            Cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
-            return uuid;
-        }
-
-        private string GetUUID()
-        {
-            return Guid.NewGuid().ToString();
-        }
-    }
-}

Helpers/ExceptionMiddleware.cs

@@ -1,71 +0,0 @@
-using System;
-using System.Threading.Tasks;
-using Microsoft.AspNetCore.Http;
-using YYApi.Communications;
-using Microsoft.AspNetCore.Builder;
-using Microsoft.Extensions.Logging;
-
-namespace YYApi.Helpers
-{
-    /// <summary>
-    /// 异常处理中间件
-    /// </summary>
-    public class ExceptionMiddleware
-    {
-        private RequestDelegate Next { get; }
-        private ILogger<ExceptionMiddleware> Log { get; }
-
-        public ExceptionMiddleware(RequestDelegate next, ILogger<ExceptionMiddleware> log)
-        {
-            Log = log;
-            Next = next;
-        }
-
-        public async Task InvokeAsync(HttpContext context)
-        {
-            var response = new BaseResponse();
-            try
-            {
-                await Next(context);
-            }
-            catch (ApiException ex)
-            {
-                response.SetCodeMsg(ex.Code, ex.Message);
-                ErrorResponse(context, response);
-            }
-            catch (Exception ex)
-            {
-                Log.LogError(ex.Message);
-                Log.LogError(ex.StackTrace);
-                response.SetCodeMsg(500, ex.Message);
-                ErrorResponse(context, response);
-            }
-        }
-
-        /// <summary>
-        /// 异常抛出错误
-        /// </summary>
-        /// <param name="context"></param>
-        /// <param name="response"></param>
-        private void ErrorResponse(HttpContext context, BaseResponse response)
-        {
-            context.Response.StatusCode = 200;
-            context.Response.Headers.Add("Content-Type", "application/json");
-            context.Response.WriteAsync(response.ToString());
-        }
-    }
-
-
-    /// <summary>
-    /// Api错误捕获异常
-    /// </summary>
-    public class ApiException : Exception
-    {
-        public int Code { get; }
-
-        public ApiException(int code, string message = "") : base(message)
-        {
-            Code = code;
-        }
-    }
-}

Helpers/SimApiAuth.cs

@@ -0,0 +1,65 @@
+using System;
+using System.Text.Json;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Caching.Distributed;
+using SimApi.Communications;
+
+namespace SimApi.Helpers
+{
+    /// <summary>
+    /// 认证助手
+    /// </summary>
+    public class SimApiAuth
+    {
+        private IDistributedCache Cache { get; }
+
+        public SimApiAuth(IDistributedCache cache)
+        {
+            Cache = cache;
+        }
+
+        /// <summary>
+        /// 产生一个Token记录并返回Token
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
+        public string Login(int id, string type = "user", string token = null)
+        {
+            return Login(id, new[] { type }, token);
+        }
+
+        /// <summary>
+        /// 产生一个Token并记录用户ID角色[多角色]
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="type"></param>
+        /// <returns></returns>
+        public string Login(int id, string[] type, string uuid = null)
+        {
+            if (uuid == null)
+            {
+                uuid = Guid.NewGuid().ToString();
+            }
+            var loginItem = new SimApiLoginItem
+            {
+                Id = id,
+                Type = type
+            };
+            Cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
+            return uuid;
+        }
+
+        /// <summary>
+        /// 退出登陆
+        /// </summary>
+        /// <param name="uuid">登陆标识</param>
+        public void Logout(string uuid)
+        {
+            if (!string.IsNullOrEmpty(uuid))
+            {
+                Cache.Remove(uuid);
+            }
+        }
+
+    }
+}

Helpers/SimApiStorage.cs

@@ -0,0 +1,97 @@
+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;
+            var endpoint = string.Empty;
+            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;
+            if (useSsl)
+            {
+                Mc = new MinioClient(endpoint, options.AccessKey, options.SecretKey).WithSSL();
+            }
+            else
+            {
+                Mc = new MinioClient(endpoint, options.AccessKey, options.SecretKey);
+            }
+
+            bool found = Mc.BucketExistsAsync(Bucket).Result;
+            if (!found)
+            {
+                Mc.MakeBucketAsync(Bucket).Wait();
+            }
+        }
+
+        public string GetUploadUrl(string path, int expire = 7200)
+        {
+            try
+            {
+                return Mc.PresignedPutObjectAsync(Bucket, path, expire).Result;
+            }
+            catch (MinioException e)
+            {
+                Console.WriteLine("Error occurred: " + e);
+                return e.Message;
+            }
+        }
+
+        public string UploadFile(string path, Stream stream)
+        {
+            try
+            {
+                Mc.PutObjectAsync(Bucket, path, stream, stream.Length).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/SimApiUtil.cs

@@ -1,11 +1,10 @@
-using System;
-using System.Security.Cryptography;
+using System.Security.Cryptography;
 using System.Text;
 using System.Text.RegularExpressions;
 
-namespace YYApi.Helpers
+namespace SimApi.Helpers
 {
-    public static class Util
+    public static class SimApiUtil
     {
         /// <summary>
         /// 检测手机号是否正确
@@ -14,7 +13,7 @@ namespace YYApi.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);
         }
 

JobService/HFDashboardAuth.cs

@@ -1,124 +0,0 @@
-using System;
-using Hangfire.Dashboard;
-using Microsoft.Extensions.Configuration;
-using Microsoft.AspNetCore.Http;
-using StackExchange.Redis;
-using System.Collections.Generic;
-using System.Text;
-using System.Security.Cryptography;
-
-namespace YYApi.JobService
-{
-    /// <summary>
-    /// Redis缓存Key定义
-    /// </summary>
-    public struct CacheKey
-    {
-        public const string HangfireDashboardAuthPrefix = "{hangfire}:dashboard:auth:";
-    }
-
-    /// <summary>
-    /// HangFire Dashboard Digest认证.
-    /// </summary>
-    public class HFDashboardAuth : IDashboardAuthorizationFilter
-    {
-        private IConfiguration _config { get; }
-        private IDatabase _redis { get; }
-        public HFDashboardAuth(IConfiguration config, IDatabase redis)
-        {
-            _redis = redis;
-            _config = config;
-        }
-
-        public bool Authorize(DashboardContext context)
-        {
-            var http = context.GetHttpContext();
-            if (http.Request.Headers.ContainsKey("Authorization"))
-            {
-                var authObj = _processAuthHeader(http.Request.Headers["Authorization"].ToString());
-                if (http.Request.QueryString.ToString().Contains("logout"))
-                {
-                    _redis.KeyDelete(CacheKey.HangfireDashboardAuthPrefix + authObj["opaque"]);
-                    _redirect(http);
-                    return true;
-                }
-                if (authObj["username"] == _config["Hangfire:User"])
-                {
-                    var a1 = _md5(string.Format("{0}:Need Login:{1}", authObj["username"], _config["Hangfire:Pass"]));
-                    var a2 = _md5(string.Format("{0}:{1}", http.Request.Method, authObj["uri"]));
-                    var nonce = _redis.StringGet(CacheKey.HangfireDashboardAuthPrefix + authObj["opaque"]);
-                    var validCode = _md5(string.Format("{0}:{1}:{2}:{3}:{4}:{5}", a1, nonce, authObj["nc"], authObj["cnonce"], authObj["qop"], a2));
-                    if (authObj["response"] == validCode)
-                    {
-                        _redis.StringSet(CacheKey.HangfireDashboardAuthPrefix + authObj["opaque"], nonce, new TimeSpan(0, 5, 0));
-                        return true;
-                    }
-                }
-            }
-            _challenge(http);
-            return false;
-        }
-
-        /// <summary>
-        /// 生成401认证header
-        /// </summary>
-        /// <returns>The challenge.</returns>
-        private void _challenge(HttpContext http)
-        {
-            var response = http.Response;
-            var guid = Guid.NewGuid().ToString();
-            var opaque = _md5(guid);
-            _redis.StringSet(CacheKey.HangfireDashboardAuthPrefix + opaque, guid, new TimeSpan(0, 0, 30));
-            response.StatusCode = 401;
-            response.Headers.Add("WWW-Authenticate", string.Format("Digest realm=\"Need Login\",qop=\"auth\",nonce=\"{0}\",opaque=\"{1}\"", guid, opaque));
-        }
-
-        /// <summary>
-        /// 跳转到页面不附加参数
-        /// </summary>
-        /// <param name="http">Http.</param>
-        private void _redirect(HttpContext http)
-        {
-            var response = http.Response;
-            response.StatusCode = 302;
-            response.Headers.Add("Location", (http.Request.PathBase + http.Request.Path).ToString());
-        }
-
-        /// <summary>
-        /// 处理DigestHeader中的参数为字典
-        /// </summary>
-        /// <returns>The auth header.</returns>
-        /// <param name="authData">Auth data.</param>
-        private Dictionary<string, string> _processAuthHeader(string authData)
-        {
-            var authDataArray = authData.Replace("Digest ", string.Empty).Replace("\"", string.Empty).Split(", ");
-            var authDic = new Dictionary<string, string>();
-            foreach (var item in authDataArray)
-            {
-                var tmp = item.Split("=", 2);
-                authDic.Add(tmp[0], tmp[1]);
-            }
-            return authDic;
-        }
-
-        /// <summary>
-        /// 计算字符串32位MD5
-        /// </summary>
-        /// <returns>The md5.</returns>
-        /// <param name="source">Source.</param>
-        private string _md5(string source)
-        {
-            byte[] sor = Encoding.UTF8.GetBytes(source);
-            var md5 = MD5.Create();
-            byte[] result = md5.ComputeHash(sor);
-            StringBuilder strbul = new StringBuilder(40);
-            for (int i = 0; i < result.Length; i++)
-            {
-                strbul.Append(result[i].ToString("x2"));//加密结果"x2"结果为32位,"x3"结果为48位,"x4"结果为64位
-
-            }
-            return strbul.ToString();
-
-        }
-    }
-}

JobService/JobDashboardConfig.cs

@@ -1,10 +0,0 @@
-using System;
-namespace YYApi.JobService
-{
-    public class JobDashboardConfig
-    {
-        public string Path { get; set; }
-        public string Username { get; set; }
-        public string Password { get; set; }
-    }
-}

JobService/JobStorage.cs

@@ -1,10 +0,0 @@
-using System;
-namespace YYApi.JobService
-{
-    public class JobStorage
-    {
-        public JobStorage()
-        {
-        }
-    }
-}

Logger/SimApiLogger.cs

@@ -0,0 +1,50 @@
+using System;
+using Microsoft.Extensions.Logging;
+
+namespace SimApi.Logger
+{
+    public class SimApiLogger : ILogger
+    {
+        private string Name { get; }
+
+        public SimApiLogger(string name)
+        {
+            Name = name;
+        }
+
+        public IDisposable BeginScope<TState>(TState state)
+        {
+            return null;
+        }
+
+        public bool IsEnabled(LogLevel logLevel)
+        {
+            return 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} ][ {DateTime.Now.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/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/SimApiAuthMiddleware.cs

@@ -0,0 +1,41 @@
+using System.Text.Json;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Caching.Distributed;
+using SimApi.Communications;
+
+namespace SimApi.Middlewares
+{
+    /// <summary>
+    /// 认证信息获取中间件
+    /// </summary>
+    public class SimApiAuthMiddleware
+    {
+        private RequestDelegate Next { get; }
+
+        public SimApiAuthMiddleware(RequestDelegate next)
+        {
+            Next = next;
+        }
+
+        public Task Invoke(HttpContext httpContext, IDistributedCache cache)
+        {
+            string token = null;
+            if (httpContext.Request.Headers.ContainsKey("Token"))
+            {
+                token = httpContext.Request.Headers["Token"];
+            }
+
+            if (!string.IsNullOrEmpty(token))
+            {
+                var login = cache.GetString(token);
+                if (login != null)
+                {
+                    httpContext.Items.Add("LoginInfo", JsonSerializer.Deserialize<SimApiLoginItem>(login));
+                }
+            }
+           
+            return Next(httpContext);
+        }
+    }
+}

Middlewares/SimApiExceptionMiddleware.cs

@@ -0,0 +1,78 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+using SimApi.Communications;
+using Microsoft.Extensions.Logging;
+using SimApi.Exceptions;
+
+namespace SimApi.Middlewares
+{
+    /// <summary>
+    /// 异常处理中间件
+    /// </summary>
+    public class SimApiExceptionMiddleware
+    {
+        private RequestDelegate Next { get; }
+        private ILogger<SimApiExceptionMiddleware> Log { get; }
+
+        public SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
+        {
+            Log = log;
+            Next = next;
+        }
+
+        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)
+            {
+                if (string.IsNullOrEmpty(ex.Message))
+                {
+                    response.SetCode(ex.Code);
+                }
+                else
+                {
+                    response.SetCodeMsg(ex.Code, ex.Message);
+                }
+
+                ErrorResponse(context, response);
+            }
+            catch (Exception ex)
+            {
+                Log.LogError(ex.Message);
+                Log.LogError(ex.StackTrace);
+                response.SetCodeMsg(500, ex.Message);
+                ErrorResponse(context, response);
+            }
+        }
+
+        /// <summary>
+        /// 异常抛出错误
+        /// </summary>
+        /// <param name="context"></param>
+        /// <param name="response"></param>
+        private void ErrorResponse(HttpContext context, SimApiBaseResponse response)
+        {
+            context.Response.StatusCode = 200;
+            context.Response.Headers.Add("Content-Type", "application/json");
+            context.Response.WriteAsync(response.ToString());
+        }
+    }
+}

Models/SimApiBaseModel.cs

@@ -0,0 +1,69 @@
+using System;
+using System.Linq;
+using System.Text.Json;
+
+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, DateTime.Now);
+        }
+    }
+}

README.md

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

SimApi.csproj

@@ -1,31 +1,36 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
     <OutputType>Library</OutputType>
     <PackOnBuild>true</PackOnBuild>
     <Version>0.2.3</Version>
-    <Authors>xRain@YYTech</Authors>
+    <Authors>xRain@SimcuTeam</Authors>
     <Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
-    <PackageId>YY-Tech.YYApi</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>
 
+  <PropertyGroup Condition=" '$(RunConfiguration)' == 'YYApi' " />
   <ItemGroup>
     <Folder Include="Helpers\" />
     <Folder Include="Communications\" />
     <Folder Include="Controllers\" />
-    <Folder Include="JobService\" />
+    <Folder Include="Middlewares\" />
+    <Folder Include="Attributes\" />
+    <Folder Include="Exceptions\" />
+    <Folder Include="Configurations\" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.0.0" />
-    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.0.0" />
-    <PackageReference Include="HangFire.Core" Version="1.7.8" />
-    <PackageReference Include="Hangfire.AspNetCore" Version="1.7.8" />
-    <PackageReference Include="Hangfire.Console" Version="1.4.2" />
-    <PackageReference Include="Hangfire.Redis.StackExchange" Version="1.8.1" />
+    <PackageReference Include="Minio" Version="3.1.13" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.2.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.2.3" />
   </ItemGroup>
   <ProjectExtensions>
     <MonoDevelop>

SimApiExtensions.cs

@@ -0,0 +1,237 @@
+using System;
+using SimApi.Helpers;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.OpenApi.Models;
+using SimApi.Middlewares;
+using Microsoft.AspNetCore.HttpOverrides;
+using Microsoft.Extensions.Logging;
+using SimApi.Configs;
+using SimApi.Logger;
+
+namespace SimApi
+{
+    /// <summary>
+    /// 加入系统的扩展信息
+    /// </summary>
+    public static class SimApiExtensions
+    {
+        //**********快捷添加**************
+        public static IServiceCollection AddSimApi(this IServiceCollection builder,
+            Action<SimApiOptions> options = null)
+        {
+            var simApiOptions = new SimApiOptions();
+            options?.Invoke(simApiOptions);
+
+            // 是否使用SIMAUTH
+            if (simApiOptions.EnableSimApiAuth)
+            {
+                builder.AddScoped<SimApiAuth>();
+            }
+
+            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)
+                    {
+                        x.SwaggerDoc(group.Id, new OpenApiInfo {Title = group.Name, Description = group.Description});
+                    }
+
+                    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});
+                    }
+                });
+            }
+
+            // 使用Header转发，应对代理后获取真实ip
+            if (simApiOptions.EnableForwardHeaders)
+            {
+                builder.Configure<ForwardedHeadersOptions>(options =>
+                {
+                    options.ForwardedHeaders = ForwardedHeaders.All;
+                    options.KnownNetworks.Clear();
+                    options.KnownProxies.Clear();
+                });
+            }
+
+            if (simApiOptions.EnableLowerUrl)
+            {
+                builder.AddRouting(options => options.LowercaseUrls = true);
+            }
+
+            if (simApiOptions.EnableSimApiStorage)
+            {
+                builder.AddHttpContextAccessor();
+                builder.AddSingleton<SimApiStorage>();
+            }
+
+            builder.AddSingleton(simApiOptions);
+            return builder;
+        }
+
+        /// <summary>
+        ///  使用所有SimApi自定义中间件
+        /// </summary>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder)
+        {
+            var options = builder.ApplicationServices.GetService<SimApiOptions>();
+            if (options.EnableLogger)
+            {
+                builder.ApplicationServices.GetService<ILoggerFactory>().AddProvider(new SimApiLoggerProvider());
+            }
+
+            var logger = builder.ApplicationServices.GetService<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;
+        }
+    }
+}