Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4171756c54 | ||
|
|
c68cfa6192 | ||
|
|
8344567ac6 | ||
|
|
99b26d99f6 | ||
|
|
cb291691d5 | ||
|
|
47a48d0103 | ||
|
|
4c50acc309 |
@@ -14,7 +14,7 @@ jobs:
|
||||
- name: Setup .NET Core
|
||||
uses: actions/setup-dotnet@v1
|
||||
with:
|
||||
dotnet-version: "7.0.100"
|
||||
dotnet-version: "8.0.200"
|
||||
- name: Publish
|
||||
run: |
|
||||
version=`git describe --tags`
|
||||
|
||||
@@ -5,61 +5,54 @@ using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.Attributes
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// 检测登录中间件
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
|
||||
public class SimApiAuthAttribute : ActionFilterAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// 检测登录中间件
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
|
||||
public class SimApiAuthAttribute : ActionFilterAttribute
|
||||
private string[] Types { get; }
|
||||
|
||||
|
||||
//默认是user登录类型
|
||||
public SimApiAuthAttribute()
|
||||
{
|
||||
private string[] Types { get; }
|
||||
Types = new[] { "user" };
|
||||
}
|
||||
|
||||
//只检测一种用户类型的快捷方式
|
||||
public SimApiAuthAttribute(string type)
|
||||
{
|
||||
Types = type.Split(",");
|
||||
}
|
||||
|
||||
//默认是user登录类型
|
||||
public SimApiAuthAttribute()
|
||||
//设定特定类型的检测
|
||||
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)
|
||||
{
|
||||
Types = new[]
|
||||
{
|
||||
"user"
|
||||
};
|
||||
throw new SimApiException(401);
|
||||
}
|
||||
|
||||
//只检测一种用户类型的快捷方式
|
||||
public SimApiAuthAttribute(string type)
|
||||
//检测用户类型
|
||||
if (!Types.Intersect(loginInfo.Type).Any())
|
||||
{
|
||||
Types = type.Split(",");
|
||||
}
|
||||
|
||||
//设定特定类型的检测
|
||||
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).Any())
|
||||
{
|
||||
throw new SimApiException(403);
|
||||
}
|
||||
throw new SimApiException(403);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,25 +1,24 @@
|
||||
using System;
|
||||
using Swashbuckle.AspNetCore.Annotations;
|
||||
|
||||
namespace SimApi.Attributes
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// 快捷自定义接口文档类
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
|
||||
public class SimApiDocAttribute : SwaggerOperationAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// 快捷自定义接口文档类
|
||||
/// 定义接口说明
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
|
||||
public class SimApiDocAttribute : SwaggerOperationAttribute
|
||||
/// <param name="tag">接口分组</param>
|
||||
/// <param name="name">接口名称</param>
|
||||
public SimApiDocAttribute(string tag, string name)
|
||||
{
|
||||
/// <summary>
|
||||
/// 定义接口说明
|
||||
/// </summary>
|
||||
/// <param name="tag">接口分组</param>
|
||||
/// <param name="name">接口名称</param>
|
||||
public SimApiDocAttribute(string tag, string name)
|
||||
{
|
||||
Tags = new[] { tag };
|
||||
Summary = name;
|
||||
// Consumes = new[] {"application/json"};
|
||||
// Produces = new[] {"application/json"};
|
||||
}
|
||||
Tags = new[] { tag };
|
||||
Summary = name;
|
||||
// Consumes = new[] {"application/json"};
|
||||
// Produces = new[] {"application/json"};
|
||||
}
|
||||
}
|
||||
@@ -1,23 +1,22 @@
|
||||
namespace SimApi.Communications
|
||||
{
|
||||
/// <summary>
|
||||
/// 只有ID的请求
|
||||
/// </summary>
|
||||
public record SimApiIdOnlyRequest(int Id);
|
||||
namespace SimApi.Communications;
|
||||
|
||||
/// <summary>
|
||||
/// 只有ID的请求(字符串)
|
||||
/// </summary>
|
||||
public record SimApiStringIdOnlyRequest(string Id);
|
||||
/// <summary>
|
||||
/// 只有ID的请求
|
||||
/// </summary>
|
||||
public record SimApiIdOnlyRequest(int Id);
|
||||
|
||||
/// <summary>
|
||||
/// 动态类型单字段请求
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public record SimApiOneFieldRequest<T>(T Data);
|
||||
/// <summary>
|
||||
/// 只有ID的请求(字符串)
|
||||
/// </summary>
|
||||
public record SimApiStringIdOnlyRequest(string Id);
|
||||
|
||||
/// <summary>
|
||||
/// 基础分页请求
|
||||
/// </summary>
|
||||
public record SimApiBasePageRequest(int Page, int Count);
|
||||
}
|
||||
/// <summary>
|
||||
/// 动态类型单字段请求
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public record SimApiOneFieldRequest<T>(T Data);
|
||||
|
||||
/// <summary>
|
||||
/// 基础分页请求
|
||||
/// </summary>
|
||||
public record SimApiBasePageRequest(int Page, int Count);
|
||||
@@ -2,75 +2,64 @@
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace SimApi.Communications
|
||||
namespace SimApi.Communications;
|
||||
|
||||
/// <summary>
|
||||
/// 基础相应
|
||||
/// </summary>
|
||||
public record SimApiBaseResponse(int Code = 200, string Message = "成功")
|
||||
{
|
||||
/// <summary>
|
||||
/// 基础相应
|
||||
/// 默认错误代码对应提示信息
|
||||
/// </summary>
|
||||
public record SimApiBaseResponse(int Code = 200, string Message = "成功")
|
||||
private static readonly Dictionary<int, string> MsgBox = new()
|
||||
{
|
||||
/// <summary>
|
||||
/// 默认错误代码对应提示信息
|
||||
/// </summary>
|
||||
private static readonly Dictionary<int, string> MsgBox = new()
|
||||
{
|
||||
{
|
||||
200, "成功"
|
||||
},
|
||||
{
|
||||
204, "没有数据"
|
||||
},
|
||||
{
|
||||
400, "参数错误"
|
||||
},
|
||||
{
|
||||
401, "需要登录"
|
||||
},
|
||||
{
|
||||
403, "无权访问"
|
||||
},
|
||||
{
|
||||
404, "接口不存在"
|
||||
},
|
||||
{
|
||||
500, "服务器错误"
|
||||
}
|
||||
};
|
||||
{ 200, "成功" },
|
||||
{ 204, "没有数据" },
|
||||
{ 400, "参数错误" },
|
||||
{ 401, "需要登录" },
|
||||
{ 403, "无权访问" },
|
||||
{ 404, "接口不存在" },
|
||||
{ 500, "服务器错误" }
|
||||
};
|
||||
|
||||
public SimApiBaseResponse(int code) : this(code, MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误")
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 序列化为JSON字符串
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public override string ToString()
|
||||
{
|
||||
return JsonSerializer.Serialize(this, new JsonSerializerOptions
|
||||
{
|
||||
IgnoreReadOnlyProperties = true,
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
Converters =
|
||||
{
|
||||
new JsonStringEnumConverter()
|
||||
}
|
||||
});
|
||||
}
|
||||
public SimApiBaseResponse(int code) : this(code, MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误")
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 动态内容分页
|
||||
/// 序列化为JSON字符串
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public record SimApiBasePageResponse<T>
|
||||
(T List, int Page = 1, int Count = 1, int Total = 1, int Code = 200,
|
||||
string Message = "成功") : SimApiBaseResponse(Code, Message);
|
||||
|
||||
/// <summary>
|
||||
/// 动态Data返回
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public record SimApiBaseResponse<T>(T Data, int Code = 200, string Message = "成功") : SimApiBaseResponse(Code,
|
||||
Message);
|
||||
/// <returns></returns>
|
||||
public override string ToString()
|
||||
{
|
||||
return JsonSerializer.Serialize(this, new JsonSerializerOptions
|
||||
{
|
||||
IgnoreReadOnlyProperties = true,
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
Converters =
|
||||
{
|
||||
new JsonStringEnumConverter()
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 动态内容分页
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public record SimApiBasePageResponse<T>(
|
||||
T List,
|
||||
int Page = 1,
|
||||
int Count = 1,
|
||||
int Total = 1,
|
||||
int Code = 200,
|
||||
string Message = "成功") : SimApiBaseResponse(Code, Message);
|
||||
|
||||
/// <summary>
|
||||
/// 动态Data返回
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public record SimApiBaseResponse<T>(T Data, int Code = 200, string Message = "成功") : SimApiBaseResponse(Code,
|
||||
Message);
|
||||
@@ -1,7 +1,6 @@
|
||||
namespace SimApi.Communications
|
||||
{
|
||||
/// <summary>
|
||||
/// 登录信息中间件
|
||||
/// </summary>
|
||||
public record SimApiLoginItem(string Id, string[] Type);
|
||||
}
|
||||
namespace SimApi.Communications;
|
||||
|
||||
/// <summary>
|
||||
/// 登录信息中间件
|
||||
/// </summary>
|
||||
public record SimApiLoginItem(string Id, string[] Type);
|
||||
@@ -1,73 +1,75 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Collections.Generic;
|
||||
using Swashbuckle.AspNetCore.SwaggerUI;
|
||||
|
||||
namespace SimApi.Configs
|
||||
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 class SimApiDocGroupOption
|
||||
public SimApiDocGroupOption[] ApiGroups { get; set; } = new[]
|
||||
{
|
||||
/// <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
|
||||
{
|
||||
new SimApiDocGroupOption
|
||||
{
|
||||
Id = "api",
|
||||
Name = "Api",
|
||||
Description = "Api接口文档"
|
||||
}
|
||||
};
|
||||
Id = "api",
|
||||
Name = "Api",
|
||||
Description = "Api接口文档"
|
||||
}
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// 授权配置
|
||||
/// </summary>
|
||||
public SimApiAuthOption ApiAuth { get; set; } = new SimApiAuthOption();
|
||||
/// <summary>
|
||||
/// 授权配置
|
||||
/// </summary>
|
||||
public SimApiAuthOption ApiAuth { get; set; } = new SimApiAuthOption();
|
||||
|
||||
/// <summary>
|
||||
/// 文档页面标题
|
||||
/// </summary>
|
||||
public string DocumentTitle { get; set; } = "API接口文档";
|
||||
/// <summary>
|
||||
/// 文档页面标题
|
||||
/// </summary>
|
||||
public string DocumentTitle { get; set; } = "API接口文档";
|
||||
|
||||
/// <summary>
|
||||
/// 接口支持的调用方式
|
||||
/// </summary>
|
||||
public SubmitMethod[] SupportedMethod { get; set; } = new[] {SubmitMethod.Post};
|
||||
}
|
||||
/// <summary>
|
||||
/// 接口支持的调用方式
|
||||
/// </summary>
|
||||
public SubmitMethod[] SupportedMethod { get; set; } = new[] { SubmitMethod.Post };
|
||||
}
|
||||
@@ -1,93 +1,92 @@
|
||||
using System;
|
||||
|
||||
namespace SimApi.Configs
|
||||
namespace SimApi.Configs;
|
||||
|
||||
public class SimApiOptions
|
||||
{
|
||||
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>
|
||||
/// 是否启用Synapse
|
||||
/// </summary>
|
||||
public bool EnableSynapse { get; set; } = false;
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Swagger文档相关配置,需要启用 EnableSimApiDoc
|
||||
/// </summary>
|
||||
public SimApiDocOptions SimApiDocOptions { get; set; } = new();
|
||||
|
||||
/// <summary>
|
||||
/// S3兼容的存储系统配置,需要启用 EnableSimApiStorage
|
||||
/// </summary>
|
||||
public SimApiStorageOptions SimApiStorageOptions { get; set; } = new();
|
||||
|
||||
public SimApiSynapseOptions SimApiSynapseOptions { get; set; } = new();
|
||||
|
||||
public void ConfigureSimApiSynapse(Action<SimApiSynapseOptions> options = null)
|
||||
{
|
||||
/// <summary>
|
||||
/// 启用全部Cors,对于开发前后分离的时候很有用。
|
||||
/// default: true
|
||||
/// </summary>
|
||||
public bool EnableCors { get; set; } = true;
|
||||
options?.Invoke(SimApiSynapseOptions);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 启用SimapiAuth,一个简单的基于Header Token的认证方式。
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableSimApiAuth { get; set; } = false;
|
||||
public void ConfigureSimApiSynapse(SimApiSynapseOptions options)
|
||||
{
|
||||
SimApiSynapseOptions = options;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 启用在线文档,启用后 访问 /swagger 可以查看对应的api文档。
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableSimApiDoc { get; set; } = false;
|
||||
public void ConfigureSimApiDoc(Action<SimApiDocOptions> options = null)
|
||||
{
|
||||
options?.Invoke(SimApiDocOptions);
|
||||
}
|
||||
|
||||
/// <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>
|
||||
/// 是否启用Synapse
|
||||
/// </summary>
|
||||
public bool EnableSynapse { 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 SimApiSynapseOptions SimApiSynapseOptions { get; set; } = new SimApiSynapseOptions();
|
||||
|
||||
public void ConfigureSimApiSynapse(Action<SimApiSynapseOptions> options = null)
|
||||
{
|
||||
options?.Invoke(SimApiSynapseOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiSynapse(SimApiSynapseOptions options)
|
||||
{
|
||||
SimApiSynapseOptions = options;
|
||||
}
|
||||
|
||||
public void ConfigureSimApiDoc(Action<SimApiDocOptions> options = null)
|
||||
{
|
||||
options?.Invoke(SimApiDocOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiStorage(Action<SimApiStorageOptions> options = null)
|
||||
{
|
||||
options?.Invoke(SimApiStorageOptions);
|
||||
}
|
||||
public void ConfigureSimApiStorage(Action<SimApiStorageOptions> options = null)
|
||||
{
|
||||
options?.Invoke(SimApiStorageOptions);
|
||||
}
|
||||
}
|
||||
@@ -1,24 +1,23 @@
|
||||
namespace SimApi.Configs
|
||||
namespace SimApi.Configs;
|
||||
|
||||
public class SimApiStorageOptions
|
||||
{
|
||||
public class SimApiStorageOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// S3 服务器入口地址
|
||||
/// </summary>
|
||||
public string Endpoint { get; set; }
|
||||
/// <summary>
|
||||
/// S3 服务器入口地址
|
||||
/// </summary>
|
||||
public string Endpoint { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// S3 服务器文件访问地址
|
||||
/// </summary>
|
||||
public string ServeUrl { get; set; }
|
||||
/// <summary>
|
||||
/// S3 服务器文件访问地址
|
||||
/// </summary>
|
||||
public string ServeUrl { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// S3服务 Bucket
|
||||
/// </summary>
|
||||
public string Bucket { get; set; }
|
||||
/// <summary>
|
||||
/// S3服务 Bucket
|
||||
/// </summary>
|
||||
public string Bucket { get; set; }
|
||||
|
||||
public string AccessKey { get; set; }
|
||||
public string AccessKey { get; set; }
|
||||
|
||||
public string SecretKey { get; set; }
|
||||
}
|
||||
public string SecretKey { get; set; }
|
||||
}
|
||||
@@ -4,84 +4,106 @@ using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
||||
using System.Linq;
|
||||
using SimApi.Exceptions;
|
||||
using SimApi.Attributes;
|
||||
|
||||
namespace SimApi.Controllers
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
/// <summary>
|
||||
/// 基础控制器,所有控制器均继承本控制器
|
||||
/// 1. 自动验证请求参数
|
||||
/// 2. 报错返回
|
||||
/// 3. 错误回馈页面
|
||||
/// </summary>
|
||||
public class SimApiBaseController : Controller
|
||||
{
|
||||
/// <summary>
|
||||
/// 基础控制器,所有控制器均继承本控制器
|
||||
/// 1. 自动验证请求参数
|
||||
/// 2. 报错返回
|
||||
/// 3. 错误回馈页面
|
||||
/// 当前登录用户的ID
|
||||
/// </summary>
|
||||
public class SimApiBaseController : Controller
|
||||
protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"];
|
||||
|
||||
/// <summary>
|
||||
/// 验证请求参数
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
public override void OnActionExecuting(ActionExecutingContext context)
|
||||
{
|
||||
/// <summary>
|
||||
/// 当前登录用户的ID
|
||||
/// </summary>
|
||||
protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"];
|
||||
|
||||
/// <summary>
|
||||
/// 验证请求参数
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
public override void OnActionExecuting(ActionExecutingContext context)
|
||||
if (!context.ModelState.IsValid)
|
||||
{
|
||||
if (!context.ModelState.IsValid)
|
||||
foreach (var item in context.ModelState.Values.Where(item =>
|
||||
item.ValidationState == ModelValidationState.Invalid))
|
||||
{
|
||||
foreach (var item in context.ModelState.Values.Where(item =>
|
||||
item.ValidationState == ModelValidationState.Invalid))
|
||||
{
|
||||
Error(400, item.Errors.First().ErrorMessage);
|
||||
break;
|
||||
}
|
||||
Error(400, item.Errors.First().ErrorMessage);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 错误返回
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
|
||||
/// <returns></returns>
|
||||
protected static void Error(int code = 500, string message = "")
|
||||
/// <summary>
|
||||
/// 错误返回
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
|
||||
/// <returns></returns>
|
||||
protected static void Error(int code = 500, string message = "")
|
||||
{
|
||||
throw new SimApiException(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhen(bool condition, int code = 500, string message = "")
|
||||
{
|
||||
if (condition)
|
||||
{
|
||||
throw new SimApiException(code, message);
|
||||
Error(code, message);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenTrue(bool condition, int code = 500, string message = "")
|
||||
{
|
||||
ErrorWhen(condition, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhen(bool condition, int code = 500, string message = "")
|
||||
{
|
||||
if (condition)
|
||||
{
|
||||
Error(code, message);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 如果condition是false 报错
|
||||
/// </summary>
|
||||
/// <param name="condition"></param>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="message"></param>
|
||||
protected static void ErrorWhenFalse(bool condition, int code = 500, string message = "")
|
||||
{
|
||||
ErrorWhen(!condition, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测给定的变量是否为NUll
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenNull(object condition, int code = 404, string message = "")
|
||||
{
|
||||
ErrorWhen(condition == null, code, message);
|
||||
}
|
||||
/// <summary>
|
||||
/// 检测给定的变量是否为NUll
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenNull(object condition, int code = 404, string message = "")
|
||||
{
|
||||
ErrorWhen(condition == null, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 上传文件
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
protected SimApiBaseResponse<string> UploadFile()
|
||||
{
|
||||
return new SimApiBaseResponse<string>(null);
|
||||
}
|
||||
/// <summary>
|
||||
/// 上传文件
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
protected SimApiBaseResponse<string> UploadFile()
|
||||
{
|
||||
return new SimApiBaseResponse<string>(null);
|
||||
}
|
||||
}
|
||||
@@ -1,60 +1,51 @@
|
||||
using System;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Controllers
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
[ApiExplorerSettings(GroupName = "api")]
|
||||
public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
|
||||
{
|
||||
[ApiExplorerSettings(GroupName = "api")]
|
||||
public class YYCommonController : SimApiBaseController
|
||||
/// <summary>
|
||||
/// 错误回馈页面
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <returns></returns>
|
||||
[HttpGet("exception/{code:int}")]
|
||||
[ApiExplorerSettings(IgnoreApi = true)]
|
||||
public SimApiBaseResponse ExceptionHandler(int code)
|
||||
{
|
||||
private SimApiAuth Auth { get; }
|
||||
return new SimApiBaseResponse(code);
|
||||
}
|
||||
|
||||
public YYCommonController(SimApiAuth auth)
|
||||
/// <summary>
|
||||
/// 检测用户登陆的控制器
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")]
|
||||
public SimApiBaseResponse<string> CheckLogin()
|
||||
{
|
||||
ErrorWhenNull(LoginInfo, 401);
|
||||
return new SimApiBaseResponse<string>(LoginInfo.Id);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 退出登陆
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost("/auth/logout"), SimApiDoc("认证", "退出登陆")]
|
||||
public SimApiBaseResponse Logout()
|
||||
{
|
||||
string token = null;
|
||||
|
||||
if (Request.Headers.TryGetValue("Token", out var value))
|
||||
{
|
||||
Auth = auth;
|
||||
token = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 错误回馈页面
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <returns></returns>
|
||||
[HttpGet("exception/{code:int}")]
|
||||
[ApiExplorerSettings(IgnoreApi = true)]
|
||||
public SimApiBaseResponse ExceptionHandler(int code)
|
||||
{
|
||||
return new SimApiBaseResponse(code);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测用户登陆的控制器
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")]
|
||||
public SimApiBaseResponse<string> CheckLogin()
|
||||
{
|
||||
ErrorWhenNull(LoginInfo, 401);
|
||||
return new SimApiBaseResponse<string>(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();
|
||||
}
|
||||
auth.Logout(token);
|
||||
return new SimApiBaseResponse();
|
||||
}
|
||||
}
|
||||
@@ -1,16 +1,11 @@
|
||||
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;
|
||||
}
|
||||
}
|
||||
namespace SimApi.Exceptions;
|
||||
|
||||
/// <summary>
|
||||
/// Api错误捕获异常
|
||||
/// </summary>
|
||||
public class SimApiException(int code, string message = "") : Exception(message)
|
||||
{
|
||||
public int Code { get; } = code;
|
||||
}
|
||||
+47
-44
@@ -1,60 +1,63 @@
|
||||
#nullable enable
|
||||
using System;
|
||||
using System.Text.Json;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using SimApi.Communications;
|
||||
|
||||
namespace SimApi.Helpers
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
/// <summary>
|
||||
/// 认证助手
|
||||
/// </summary>
|
||||
public class SimApiAuth(IDistributedCache cache)
|
||||
{
|
||||
/// <summary>
|
||||
/// 认证助手
|
||||
/// 产生一个Token记录并返回Token
|
||||
/// </summary>
|
||||
public class SimApiAuth
|
||||
/// <param name="id"></param>
|
||||
/// <param name="type"></param>
|
||||
/// <param name="token"></param>
|
||||
/// <returns></returns>
|
||||
public string Login(string id, string type = "user", string token = null)
|
||||
{
|
||||
private IDistributedCache Cache { get; }
|
||||
return Login(id, new[] { type }, token);
|
||||
}
|
||||
|
||||
public SimApiAuth(IDistributedCache cache)
|
||||
{
|
||||
Cache = cache;
|
||||
}
|
||||
/// <summary>
|
||||
/// 产生一个Token并记录用户ID角色[多角色]
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <param name="type"></param>
|
||||
/// <param name="uuid"></param>
|
||||
/// <returns></returns>
|
||||
public string Login(string id, string[] type, string uuid = null)
|
||||
{
|
||||
uuid ??= Guid.NewGuid().ToString();
|
||||
var loginItem = new SimApiLoginItem(id, type);
|
||||
cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
|
||||
return uuid;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 产生一个Token记录并返回Token
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <returns></returns>
|
||||
public string Login(string id, string type = "user", string token = null)
|
||||
{
|
||||
return Login(id, new[]
|
||||
{
|
||||
type
|
||||
}, token);
|
||||
}
|
||||
/// <summary>
|
||||
/// 获取登陆信息
|
||||
/// </summary>
|
||||
/// <param name="token"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiLoginItem? GetLogin(string token)
|
||||
{
|
||||
var login = cache.GetString(token);
|
||||
return login != null ? JsonSerializer.Deserialize<SimApiLoginItem>(login) : default;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 产生一个Token并记录用户ID角色[多角色]
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <param name="type"></param>
|
||||
/// <returns></returns>
|
||||
public string Login(string id, string[] type, string uuid = null)
|
||||
/// <summary>
|
||||
/// 退出登陆
|
||||
/// </summary>
|
||||
/// <param name="uuid">登陆标识</param>
|
||||
public void Logout(string uuid)
|
||||
{
|
||||
if (!string.IsNullOrEmpty(uuid))
|
||||
{
|
||||
uuid ??= Guid.NewGuid().ToString();
|
||||
var loginItem = new SimApiLoginItem(id, 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);
|
||||
}
|
||||
cache.Remove(uuid);
|
||||
}
|
||||
}
|
||||
}
|
||||
+83
-85
@@ -2,102 +2,100 @@
|
||||
using System.IO;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Minio;
|
||||
using Minio.Exceptions;
|
||||
using SimApi.Configs;
|
||||
|
||||
namespace SimApi.Helpers
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public class SimApiStorage
|
||||
{
|
||||
public class SimApiStorage
|
||||
private MinioClient Mc { get; }
|
||||
|
||||
public MinioClient Client => Mc;
|
||||
|
||||
private string ServeUrl { get; }
|
||||
|
||||
public string Bucket { get; }
|
||||
|
||||
private IHttpContextAccessor HttpContextAccessor { get; }
|
||||
|
||||
public SimApiStorage(SimApiOptions apiOptions, IHttpContextAccessor httpContextAccessor)
|
||||
{
|
||||
private MinioClient Mc { get; }
|
||||
|
||||
public MinioClient Client => Mc;
|
||||
|
||||
private string ServeUrl { get; }
|
||||
|
||||
public 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://"))
|
||||
{
|
||||
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();
|
||||
|
||||
var found = Mc.BucketExistsAsync(new BucketExistsArgs().WithBucket(Bucket)).Result;
|
||||
if (!found)
|
||||
{
|
||||
Mc.MakeBucketAsync(new MakeBucketArgs().WithBucket(Bucket)).Wait();
|
||||
}
|
||||
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");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取上传的URL
|
||||
/// </summary>
|
||||
/// <param name="path"></param>
|
||||
/// <param name="expire"></param>
|
||||
/// <returns></returns>
|
||||
public string GetUploadUrl(string path, int expire = 7200)
|
||||
ServeUrl = options.ServeUrl;
|
||||
Bucket = options.Bucket;
|
||||
var mcb = new MinioClient().WithEndpoint(endpoint)
|
||||
.WithCredentials(options.AccessKey, options.SecretKey);
|
||||
if (useSsl)
|
||||
{
|
||||
return Mc.PresignedPutObjectAsync(new PresignedPutObjectArgs().WithBucket(Bucket)
|
||||
.WithObject(path).WithExpiry(expire)).Result;
|
||||
mcb = mcb.WithSSL();
|
||||
}
|
||||
Mc = mcb.Build();
|
||||
|
||||
/// <summary>
|
||||
/// 获取下载的URL
|
||||
/// </summary>
|
||||
/// <param name="path"></param>
|
||||
/// <param name="expire"></param>
|
||||
/// <returns></returns>
|
||||
public string GetDownloadUrl(string path, int expire = 600)
|
||||
var found = Mc.BucketExistsAsync(new BucketExistsArgs().WithBucket(Bucket)).Result;
|
||||
if (!found)
|
||||
{
|
||||
return Mc.PresignedGetObjectAsync(new PresignedGetObjectArgs().WithBucket(Bucket).WithObject(path)
|
||||
.WithExpiry(expire)).Result;
|
||||
}
|
||||
|
||||
|
||||
public string UploadFile(string path, Stream stream, string contentType = "image/png")
|
||||
{
|
||||
Mc.PutObjectAsync(new PutObjectArgs().WithBucket(Bucket).WithObject(path).WithObjectSize(stream.Length)
|
||||
.WithStreamData(stream).WithContentType(contentType)).Wait();
|
||||
return null;
|
||||
}
|
||||
|
||||
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}";
|
||||
Mc.MakeBucketAsync(new MakeBucketArgs().WithBucket(Bucket)).Wait();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取上传的URL
|
||||
/// </summary>
|
||||
/// <param name="path"></param>
|
||||
/// <param name="expire"></param>
|
||||
/// <returns></returns>
|
||||
public string GetUploadUrl(string path, int expire = 7200)
|
||||
{
|
||||
return Mc.PresignedPutObjectAsync(new PresignedPutObjectArgs().WithBucket(Bucket)
|
||||
.WithObject(path).WithExpiry(expire)).Result;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取下载的URL
|
||||
/// </summary>
|
||||
/// <param name="path"></param>
|
||||
/// <param name="expire"></param>
|
||||
/// <returns></returns>
|
||||
public string GetDownloadUrl(string path, int expire = 600)
|
||||
{
|
||||
return Mc.PresignedGetObjectAsync(new PresignedGetObjectArgs().WithBucket(Bucket).WithObject(path)
|
||||
.WithExpiry(expire)).Result;
|
||||
}
|
||||
|
||||
|
||||
public string UploadFile(string path, Stream stream, string contentType = "image/png")
|
||||
{
|
||||
Mc.PutObjectAsync(new PutObjectArgs().WithBucket(Bucket).WithObject(path).WithObjectSize(stream.Length)
|
||||
.WithStreamData(stream).WithContentType(contentType)).Wait();
|
||||
return null;
|
||||
}
|
||||
|
||||
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('~') ? string.Concat(url, path.AsSpan(1, path.Length - 1)) : $"{ServeUrl}{path}";
|
||||
}
|
||||
}
|
||||
+56
-57
@@ -7,69 +7,68 @@ using System.Text.Json.Serialization;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Text.Unicode;
|
||||
|
||||
namespace SimApi.Helpers
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public static class SimApiUtil
|
||||
{
|
||||
public static class SimApiUtil
|
||||
/// <summary>
|
||||
/// 当前CST时间
|
||||
/// </summary>
|
||||
public static DateTime CstNow => DateTime.UtcNow.AddHours(8);
|
||||
|
||||
/// <summary>
|
||||
/// JSON序列化常规选项
|
||||
/// </summary>
|
||||
public static JsonSerializerOptions JsonOption => new()
|
||||
{
|
||||
/// <summary>
|
||||
/// 当前CST时间
|
||||
/// </summary>
|
||||
public static DateTime CstNow => DateTime.UtcNow.AddHours(8);
|
||||
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// JSON序列化常规选项
|
||||
/// </summary>
|
||||
public static JsonSerializerOptions JsonOption => new()
|
||||
/// <summary>
|
||||
/// 当前秒级时间戳
|
||||
/// </summary>
|
||||
public static double TimestampNow => (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0)).TotalSeconds;
|
||||
|
||||
/// <summary>
|
||||
/// 检测手机号是否正确
|
||||
/// </summary>
|
||||
/// <param name="cell">手机号码</param>
|
||||
/// <returns></returns>
|
||||
public static bool CheckCell(string cell)
|
||||
{
|
||||
var regex = new Regex("^1[3456789]\\d{9}$");
|
||||
return regex.IsMatch(cell);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// MD5加密字符串
|
||||
/// </summary>
|
||||
/// <param name="source">源字符串</param>
|
||||
/// <param name="mode">加密结果"x2"结果为32位,"x3"结果为48位,"x4"结果为64位</param>
|
||||
/// <returns></returns>
|
||||
public static string Md5(string source, string mode = "x2")
|
||||
{
|
||||
var sor = Encoding.UTF8.GetBytes(source);
|
||||
var md5 = MD5.Create();
|
||||
var result = md5.ComputeHash(sor);
|
||||
var strbul = new StringBuilder(40);
|
||||
foreach (var t in result)
|
||||
{
|
||||
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// 当前秒级时间戳
|
||||
/// </summary>
|
||||
public static double TimestampNow => (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0)).TotalSeconds;
|
||||
|
||||
/// <summary>
|
||||
/// 检测手机号是否正确
|
||||
/// </summary>
|
||||
/// <param name="cell">手机号码</param>
|
||||
/// <returns></returns>
|
||||
public static bool CheckCell(string cell)
|
||||
{
|
||||
var regex = new Regex("^1[3456789]\\d{9}$");
|
||||
return regex.IsMatch(cell);
|
||||
strbul.Append(t.ToString(mode));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// MD5加密字符串
|
||||
/// </summary>
|
||||
/// <param name="source">源字符串</param>
|
||||
/// <param name="mode">加密结果"x2"结果为32位,"x3"结果为48位,"x4"结果为64位</param>
|
||||
/// <returns></returns>
|
||||
public static string Md5(string source, string mode = "x2")
|
||||
{
|
||||
var sor = Encoding.UTF8.GetBytes(source);
|
||||
var md5 = MD5.Create();
|
||||
var result = md5.ComputeHash(sor);
|
||||
var strbul = new StringBuilder(40);
|
||||
foreach (var t in result)
|
||||
{
|
||||
strbul.Append(t.ToString(mode));
|
||||
}
|
||||
return strbul.ToString();
|
||||
}
|
||||
|
||||
return strbul.ToString();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 将对象序列化成JSON (控制台输出中文不会被编码)
|
||||
/// </summary>
|
||||
/// <param name="obj"></param>
|
||||
/// <returns></returns>
|
||||
public static string Json(object obj)
|
||||
{
|
||||
return JsonSerializer.Serialize(obj, JsonOption);
|
||||
}
|
||||
/// <summary>
|
||||
/// 将对象序列化成JSON (控制台输出中文不会被编码)
|
||||
/// </summary>
|
||||
/// <param name="obj"></param>
|
||||
/// <returns></returns>
|
||||
public static string Json(object obj)
|
||||
{
|
||||
return JsonSerializer.Serialize(obj, JsonOption);
|
||||
}
|
||||
}
|
||||
+22
-30
@@ -2,40 +2,32 @@ using System;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Logger
|
||||
namespace SimApi.Logger;
|
||||
|
||||
public class SimApiLogger(string name) : ILogger
|
||||
{
|
||||
public class SimApiLogger : ILogger
|
||||
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)
|
||||
{
|
||||
private string Name { get; }
|
||||
|
||||
public SimApiLogger(string name)
|
||||
Console.ForegroundColor = logLevel switch
|
||||
{
|
||||
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)
|
||||
LogLevel.Debug => ConsoleColor.DarkMagenta,
|
||||
LogLevel.Information => ConsoleColor.DarkCyan,
|
||||
LogLevel.Warning => ConsoleColor.Yellow,
|
||||
LogLevel.Error => ConsoleColor.Red,
|
||||
LogLevel.Critical => ConsoleColor.DarkRed,
|
||||
_ => ConsoleColor.White
|
||||
};
|
||||
var message =
|
||||
$"[ {name} ][ {SimApiUtil.CstNow.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n";
|
||||
if (exception != null)
|
||||
{
|
||||
Console.ForegroundColor = logLevel switch
|
||||
{
|
||||
LogLevel.Debug => ConsoleColor.DarkMagenta,
|
||||
LogLevel.Information => ConsoleColor.DarkCyan,
|
||||
LogLevel.Warning => ConsoleColor.Yellow,
|
||||
LogLevel.Error => ConsoleColor.Red,
|
||||
LogLevel.Critical => ConsoleColor.DarkRed,
|
||||
_ => ConsoleColor.White
|
||||
};
|
||||
var message =
|
||||
$"[ {Name} ][ {SimApiUtil.CstNow.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n";
|
||||
if (exception != null)
|
||||
{
|
||||
message += $"{exception}\n";
|
||||
}
|
||||
Console.WriteLine(message);
|
||||
message += $"{exception}\n";
|
||||
}
|
||||
Console.WriteLine(message);
|
||||
}
|
||||
}
|
||||
@@ -1,22 +1,20 @@
|
||||
using System.Collections.Concurrent;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace SimApi.Logger
|
||||
namespace SimApi.Logger;
|
||||
|
||||
public class SimApiLoggerProvider : ILoggerProvider
|
||||
{
|
||||
public class SimApiLoggerProvider : ILoggerProvider
|
||||
private readonly ConcurrentDictionary<string, SimApiLogger> _loggers = new();
|
||||
|
||||
|
||||
public ILogger CreateLogger(string categoryName)
|
||||
{
|
||||
private readonly ConcurrentDictionary<string, SimApiLogger> _loggers =
|
||||
new ConcurrentDictionary<string, SimApiLogger>();
|
||||
return _loggers.GetOrAdd(categoryName, name => new SimApiLogger(name));
|
||||
}
|
||||
|
||||
|
||||
public ILogger CreateLogger(string categoryName)
|
||||
{
|
||||
return _loggers.GetOrAdd(categoryName, name => new SimApiLogger(name));
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
_loggers.Clear();
|
||||
}
|
||||
public void Dispose()
|
||||
{
|
||||
_loggers.Clear();
|
||||
}
|
||||
}
|
||||
@@ -3,39 +3,32 @@ using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Middlewares
|
||||
namespace SimApi.Middlewares;
|
||||
|
||||
/// <summary>
|
||||
/// 认证信息获取中间件
|
||||
/// </summary>
|
||||
public class SimApiAuthMiddleware(RequestDelegate next)
|
||||
{
|
||||
/// <summary>
|
||||
/// 认证信息获取中间件
|
||||
/// </summary>
|
||||
public class SimApiAuthMiddleware
|
||||
public Task Invoke(HttpContext httpContext, IDistributedCache cache, SimApiAuth auth)
|
||||
{
|
||||
private RequestDelegate Next { get; }
|
||||
|
||||
public SimApiAuthMiddleware(RequestDelegate next)
|
||||
string token = null;
|
||||
if (httpContext.Request.Headers.TryGetValue("Token", out var header))
|
||||
{
|
||||
Next = next;
|
||||
token = header;
|
||||
}
|
||||
|
||||
public Task Invoke(HttpContext httpContext, IDistributedCache cache)
|
||||
if (!string.IsNullOrEmpty(token))
|
||||
{
|
||||
string token = null;
|
||||
if (httpContext.Request.Headers.ContainsKey("Token"))
|
||||
var login = auth.GetLogin(token);
|
||||
if (login != null)
|
||||
{
|
||||
token = httpContext.Request.Headers["Token"];
|
||||
httpContext.Items.Add("LoginInfo", login);
|
||||
}
|
||||
|
||||
if (!string.IsNullOrEmpty(token))
|
||||
{
|
||||
var login = cache.GetString(token);
|
||||
if (login != null)
|
||||
{
|
||||
httpContext.Items.Add("LoginInfo", JsonSerializer.Deserialize<SimApiLoginItem>(login));
|
||||
}
|
||||
}
|
||||
|
||||
return Next(httpContext);
|
||||
}
|
||||
|
||||
return next(httpContext);
|
||||
}
|
||||
}
|
||||
@@ -6,75 +6,61 @@ using SimApi.Communications;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.Middlewares
|
||||
namespace SimApi.Middlewares;
|
||||
|
||||
/// <summary>
|
||||
/// 异常处理中间件
|
||||
/// </summary>
|
||||
public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
|
||||
{
|
||||
/// <summary>
|
||||
/// 异常处理中间件
|
||||
/// </summary>
|
||||
public class SimApiExceptionMiddleware
|
||||
public async Task InvokeAsync(HttpContext context)
|
||||
{
|
||||
private RequestDelegate Next { get; }
|
||||
|
||||
private ILogger<SimApiExceptionMiddleware> Log { get; }
|
||||
|
||||
public SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
|
||||
if (context.Request.Headers.TryGetValue("Query-Id", out var header))
|
||||
{
|
||||
Log = log;
|
||||
Next = next;
|
||||
context.Response.Headers["Query-Id"] = header;
|
||||
}
|
||||
|
||||
public async Task InvokeAsync(HttpContext context)
|
||||
SimApiBaseResponse response;
|
||||
try
|
||||
{
|
||||
if (context.Request.Headers.ContainsKey("Query-Id"))
|
||||
await next(context);
|
||||
if (context.Response.StatusCode != 200)
|
||||
{
|
||||
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))
|
||||
{
|
||||
if (!new[]
|
||||
{
|
||||
301, 302
|
||||
}.Contains(context.Response.StatusCode))
|
||||
{
|
||||
throw new SimApiException(context.Response.StatusCode);
|
||||
}
|
||||
throw new SimApiException(context.Response.StatusCode);
|
||||
}
|
||||
}
|
||||
catch (SimApiException ex)
|
||||
{
|
||||
response = string.IsNullOrEmpty(ex.Message)
|
||||
? new SimApiBaseResponse(ex.Code)
|
||||
: new SimApiBaseResponse(ex.Code, ex.Message);
|
||||
|
||||
ErrorResponse(context, response);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Log.LogError(ex.Message);
|
||||
Log.LogError(ex.StackTrace);
|
||||
response = new SimApiBaseResponse(500, ex.Message);
|
||||
ErrorResponse(context, response);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 异常抛出错误
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
/// <param name="response"></param>
|
||||
private void ErrorResponse(HttpContext context, SimApiBaseResponse response)
|
||||
catch (SimApiException ex)
|
||||
{
|
||||
if (!context.Response.HasStarted)
|
||||
{
|
||||
context.Response.StatusCode = 200;
|
||||
context.Response.Headers.Add("Content-Type", "application/json");
|
||||
context.Response.WriteAsync(response.ToString());
|
||||
}
|
||||
response = string.IsNullOrEmpty(ex.Message)
|
||||
? new SimApiBaseResponse(ex.Code)
|
||||
: new SimApiBaseResponse(ex.Code, ex.Message);
|
||||
|
||||
ErrorResponse(context, response);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
log.LogError(ex.Message);
|
||||
log.LogError(ex.StackTrace);
|
||||
response = new SimApiBaseResponse(500, ex.Message);
|
||||
ErrorResponse(context, response);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 异常抛出错误
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
/// <param name="response"></param>
|
||||
private void ErrorResponse(HttpContext context, SimApiBaseResponse response)
|
||||
{
|
||||
if (!context.Response.HasStarted)
|
||||
{
|
||||
context.Response.StatusCode = 200;
|
||||
context.Response.Headers.Append("Content-Type", "application/json");
|
||||
context.Response.WriteAsync(response.ToString());
|
||||
}
|
||||
}
|
||||
}
|
||||
+76
-71
@@ -1,84 +1,89 @@
|
||||
using System;
|
||||
using System.ComponentModel.DataAnnotations.Schema;
|
||||
using System.Linq;
|
||||
using System.Text.Json;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Models
|
||||
namespace SimApi.Models;
|
||||
|
||||
public class SimApiBaseModel
|
||||
{
|
||||
public class SimApiBaseModel
|
||||
[Column(Order = 1)]
|
||||
public string Id { get; set; } = Guid.NewGuid().ToString();
|
||||
|
||||
[Column(Order = 9998)]
|
||||
public DateTime UpdatedAt { get; set; } = SimApiUtil.CstNow;
|
||||
|
||||
[Column(Order = 9999)]
|
||||
public DateTime CreatedAt { get; set; } = SimApiUtil.CstNow;
|
||||
|
||||
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)
|
||||
{
|
||||
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.Where(sp =>
|
||||
targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
|
||||
(!MapperIgnoreField.Contains(sp.Key) || mapAll)))
|
||||
//获取要赋值的源数据不为null的项目
|
||||
var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
|
||||
.Select(x => new
|
||||
{
|
||||
GetType().GetProperty(sp.Key)?
|
||||
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
|
||||
}
|
||||
x.Name,
|
||||
x.PropertyType
|
||||
})
|
||||
.ToDictionary(x => x.Name, x => x.PropertyType);
|
||||
|
||||
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.Where(sp =>
|
||||
targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
|
||||
mapFields.Contains(sp.Key)))
|
||||
//获取目标对象的属性信息
|
||||
var targetProps = GetType().GetProperties().Select(x => new
|
||||
{
|
||||
GetType().GetProperty(sp.Key)?
|
||||
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
|
||||
}
|
||||
|
||||
UpdateTime();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 更新update时间
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public void UpdateTime()
|
||||
x.Name,
|
||||
x.PropertyType
|
||||
})
|
||||
.ToDictionary(x => x.Name, x => x.PropertyType);
|
||||
foreach (var sp in sourceProps.Where(sp =>
|
||||
targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
|
||||
(!MapperIgnoreField.Contains(sp.Key) || mapAll)))
|
||||
{
|
||||
GetType().GetProperty(UpdatedTimeField)?.SetValue(this, SimApiUtil.CstNow);
|
||||
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.Where(sp =>
|
||||
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);
|
||||
}
|
||||
}
|
||||
+38
-38
@@ -1,42 +1,42 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Library</OutputType>
|
||||
<PackOnBuild>true</PackOnBuild>
|
||||
<Version>0.2.3</Version>
|
||||
<Authors>xRain@SimcuTeam</Authors>
|
||||
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
||||
<PackageId>Simcu.SimApi</PackageId>
|
||||
<IsPackable>true</IsPackable>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<IncludeSymbols>true</IncludeSymbols>
|
||||
<ReleaseVersion>5.0.0</ReleaseVersion>
|
||||
<SynchReleaseVersion>false</SynchReleaseVersion>
|
||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||
<PackageVersion>5.0.2</PackageVersion>
|
||||
<TargetFramework>net7.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
<PropertyGroup>
|
||||
<OutputType>Library</OutputType>
|
||||
<PackOnBuild>true</PackOnBuild>
|
||||
<Version>0.2.3</Version>
|
||||
<Authors>xRain@SimcuTeam</Authors>
|
||||
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
||||
<PackageId>Simcu.SimApi</PackageId>
|
||||
<IsPackable>true</IsPackable>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<IncludeSymbols>true</IncludeSymbols>
|
||||
<ReleaseVersion>5.0.0</ReleaseVersion>
|
||||
<SynchReleaseVersion>false</SynchReleaseVersion>
|
||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||
<PackageVersion>5.0.2</PackageVersion>
|
||||
<TargetFramework>net8.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Folder Include="Helpers\" />
|
||||
<Folder Include="Communications\" />
|
||||
<Folder Include="Controllers\" />
|
||||
<Folder Include="Middlewares\" />
|
||||
<Folder Include="Exceptions\" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Minio" Version="4.0.7" />
|
||||
<PackageReference Include="RabbitMQ.Client" Version="6.6.0" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.5.0" />
|
||||
</ItemGroup>
|
||||
<ProjectExtensions>
|
||||
<MonoDevelop>
|
||||
<Properties>
|
||||
<Policies>
|
||||
<DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical" />
|
||||
</Policies>
|
||||
</Properties>
|
||||
</MonoDevelop>
|
||||
</ProjectExtensions>
|
||||
<ItemGroup>
|
||||
<Folder Include="Helpers\"/>
|
||||
<Folder Include="Communications\"/>
|
||||
<Folder Include="Controllers\"/>
|
||||
<Folder Include="Middlewares\"/>
|
||||
<Folder Include="Exceptions\"/>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Minio" Version="4.0.7"/>
|
||||
<PackageReference Include="RabbitMQ.Client" Version="6.6.0"/>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0"/>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.5.0"/>
|
||||
</ItemGroup>
|
||||
<ProjectExtensions>
|
||||
<MonoDevelop>
|
||||
<Properties>
|
||||
<Policies>
|
||||
<DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical"/>
|
||||
</Policies>
|
||||
</Properties>
|
||||
</MonoDevelop>
|
||||
</ProjectExtensions>
|
||||
</Project>
|
||||
|
||||
+228
-229
@@ -9,257 +9,256 @@ using Microsoft.Extensions.Logging;
|
||||
using SimApi.Configs;
|
||||
using SimApi.Logger;
|
||||
|
||||
namespace SimApi
|
||||
namespace SimApi;
|
||||
|
||||
/// <summary>
|
||||
/// 加入系统的扩展信息
|
||||
/// </summary>
|
||||
public static class SimApiExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// 加入系统的扩展信息
|
||||
/// </summary>
|
||||
public static class SimApiExtensions
|
||||
//**********快捷添加**************
|
||||
public static IServiceCollection AddSimApi(this IServiceCollection builder,
|
||||
Action<SimApiOptions> options = null)
|
||||
{
|
||||
//**********快捷添加**************
|
||||
public static IServiceCollection AddSimApi(this IServiceCollection builder,
|
||||
Action<SimApiOptions> options = null)
|
||||
var simApiOptions = new SimApiOptions();
|
||||
options?.Invoke(simApiOptions);
|
||||
if (simApiOptions.EnableLogger)
|
||||
{
|
||||
var simApiOptions = new SimApiOptions();
|
||||
options?.Invoke(simApiOptions);
|
||||
if (simApiOptions.EnableLogger)
|
||||
builder.AddLogging(logger =>
|
||||
{
|
||||
builder.AddLogging(logger =>
|
||||
logger.ClearProviders();
|
||||
logger.AddProvider(new SimApiLoggerProvider());
|
||||
});
|
||||
}
|
||||
// 是否使用 AUTH
|
||||
if (simApiOptions.EnableSimApiAuth)
|
||||
{
|
||||
builder.AddSingleton<SimApiAuth>();
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableCors)
|
||||
{
|
||||
builder.AddCors(cors => cors.AddPolicy("any",
|
||||
policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); }));
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSynapse)
|
||||
{
|
||||
builder.AddSingleton<Synapse>();
|
||||
}
|
||||
|
||||
// 使用SimApiDoc
|
||||
if (simApiOptions.EnableSimApiDoc)
|
||||
{
|
||||
var docOptions = simApiOptions.SimApiDocOptions;
|
||||
builder.AddSwaggerGen(x =>
|
||||
{
|
||||
foreach (var group in docOptions.ApiGroups)
|
||||
{
|
||||
logger.ClearProviders();
|
||||
logger.AddProvider(new SimApiLoggerProvider());
|
||||
});
|
||||
}
|
||||
// 是否使用 AUTH
|
||||
if (simApiOptions.EnableSimApiAuth)
|
||||
{
|
||||
builder.AddScoped<SimApiAuth>();
|
||||
}
|
||||
x.SwaggerDoc(group.Id, new OpenApiInfo
|
||||
{
|
||||
Title = group.Name,
|
||||
Description = group.Description
|
||||
});
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableCors)
|
||||
{
|
||||
builder.AddCors(cors => cors.AddPolicy("any",
|
||||
policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); }));
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSynapse)
|
||||
{
|
||||
builder.AddSingleton<Synapse>();
|
||||
}
|
||||
|
||||
// 使用SimApiDoc
|
||||
if (simApiOptions.EnableSimApiDoc)
|
||||
{
|
||||
var docOptions = simApiOptions.SimApiDocOptions;
|
||||
builder.AddSwaggerGen(x =>
|
||||
x.EnableAnnotations();
|
||||
var haveOauth = false;
|
||||
var haveSimApiAuth = false;
|
||||
var oauthFlows = new OpenApiOAuthFlows();
|
||||
foreach (var auth in docOptions.ApiAuth.Type)
|
||||
{
|
||||
foreach (var group in docOptions.ApiGroups)
|
||||
switch (auth)
|
||||
{
|
||||
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
|
||||
{
|
||||
case "SimApiAuth":
|
||||
x.AddSecurityRequirement(new OpenApiSecurityRequirement
|
||||
{
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Reference = new OpenApiReference
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Type = ReferenceType.SecurityScheme,
|
||||
Id = "oauth2"
|
||||
}
|
||||
},
|
||||
new[] { "SimApiAuth" }
|
||||
}
|
||||
});
|
||||
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 (haveSimApiAuth)
|
||||
if (haveOauth)
|
||||
{
|
||||
x.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
|
||||
{
|
||||
x.AddSecurityDefinition("HeaderToken",
|
||||
Type = SecuritySchemeType.OAuth2,
|
||||
Flows = oauthFlows,
|
||||
Description = docOptions.ApiAuth.Description,
|
||||
In = ParameterLocation.Header
|
||||
});
|
||||
x.AddSecurityRequirement(new OpenApiSecurityRequirement
|
||||
{
|
||||
{
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Name = "Token",
|
||||
In = ParameterLocation.Header
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
Reference = new OpenApiReference
|
||||
{
|
||||
Type = ReferenceType.SecurityScheme,
|
||||
Id = "oauth2"
|
||||
}
|
||||
},
|
||||
new[] { "SimApiAuth" }
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// 使用Header转发,应对代理后获取真实ip
|
||||
if (simApiOptions.EnableForwardHeaders)
|
||||
{
|
||||
builder.Configure<ForwardedHeadersOptions>(fwOptions =>
|
||||
if (haveSimApiAuth)
|
||||
{
|
||||
fwOptions.ForwardedHeaders = ForwardedHeaders.All;
|
||||
fwOptions.KnownNetworks.Clear();
|
||||
fwOptions.KnownProxies.Clear();
|
||||
});
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableLowerUrl)
|
||||
{
|
||||
builder.AddRouting(rOptions => rOptions.LowercaseUrls = true);
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSimApiStorage)
|
||||
{
|
||||
builder.AddHttpContextAccessor();
|
||||
builder.AddSingleton<SimApiStorage>();
|
||||
}
|
||||
|
||||
builder.AddSingleton(simApiOptions);
|
||||
return builder;
|
||||
x.AddSecurityDefinition("HeaderToken",
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Name = "Token",
|
||||
In = ParameterLocation.Header
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 使用所有SimApi自定义中间件
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <returns></returns>
|
||||
public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder)
|
||||
// 使用Header转发,应对代理后获取真实ip
|
||||
if (simApiOptions.EnableForwardHeaders)
|
||||
{
|
||||
var options = builder.ApplicationServices.GetRequiredService<SimApiOptions>();
|
||||
|
||||
var logger = builder.ApplicationServices.GetRequiredService<ILogger<SimApiOptions>>();
|
||||
|
||||
if (options.EnableForwardHeaders)
|
||||
builder.Configure<ForwardedHeadersOptions>(fwOptions =>
|
||||
{
|
||||
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小写...");
|
||||
}
|
||||
|
||||
if (options.EnableSynapse)
|
||||
{
|
||||
var synapse = builder.ApplicationServices.GetRequiredService<Synapse>();
|
||||
synapse.Init();
|
||||
}
|
||||
|
||||
return builder;
|
||||
fwOptions.ForwardedHeaders = ForwardedHeaders.All;
|
||||
fwOptions.KnownNetworks.Clear();
|
||||
fwOptions.KnownProxies.Clear();
|
||||
});
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableLowerUrl)
|
||||
{
|
||||
builder.AddRouting(rOptions => rOptions.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.GetRequiredService<SimApiOptions>();
|
||||
|
||||
var logger = builder.ApplicationServices.GetRequiredService<ILogger<SimApiOptions>>();
|
||||
|
||||
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小写...");
|
||||
}
|
||||
|
||||
if (options.EnableSynapse)
|
||||
{
|
||||
var synapse = builder.ApplicationServices.GetRequiredService<Synapse>();
|
||||
synapse.Init();
|
||||
}
|
||||
|
||||
return builder;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user