Compare commits

...
18 Commits
Author SHA1 Message Date
xrain c6b9746603 .netcoreapp 5 2020-11-28 18:03:20 +08:00
xrain f7e1b9be2a complete with .net core 5.0.0 2020-11-11 03:28:09 +08:00
xrain d0fe883e74 opt 2020-08-29 11:49:44 +08:00
xrain e4773f3154 fix error response message, error namespace. now useMiddleware dont need api doc title 2020-08-23 21:42:41 +08:00
xrain ba7b3ecd60 fix error namesapce 2020-08-23 19:51:37 +08:00
xrain f52c19938f fix ci 2020-08-05 15:44:58 +08:00
xrain 83ab8ba385 fix ci 2020-08-05 15:36:39 +08:00
xrain 7d70e8326a fix ci 2020-08-05 15:32:21 +08:00
xrain 2abe486151 fix namesapce 2020-08-05 15:29:56 +08:00
xrain f1138a5a10 remove hangfire 2020-08-01 17:36:27 +08:00
xrain 31df4a7593 add auth check 2020-07-05 06:09:02 +08:00
xrain dbc05c13ee fix ci 2020-06-28 06:36:51 +08:00
xrainandGitHub e90cc2d86e Update main.yml 2020-06-28 06:33:58 +08:00
xrain 3cbd8b7559 update depenincy, add login and logout support 2020-06-28 06:28:51 +08:00
xrain d54b71badb update package; add write file 2020-03-12 11:46:30 +08:00
xrain ddeb2948b7 add static any file 2020-03-11 23:27:17 +08:00
xrain fb1ce7d931 fix savefile response 2020-03-04 12:07:49 +08:00
xrain c117d9ef1f fix savefile response 2020-03-03 15:23:56 +08:00
21 changed files with 292 additions and 318 deletions
+3 -3
View File
@@ -1,4 +1,4 @@
name: CI name: PublishNugetPackage
on: [create] on: [create]
@@ -29,6 +29,6 @@ jobs:
run: | run: |
version=`git describe --tags` version=`git describe --tags`
dotnet pack --configuration release -p:PackageVersion=$version 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 dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
env: env:
APIKEY: ${{ secrets.APPKEY }} NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}
@@ -1,49 +1,58 @@
using System; using System;
using System.Linq; using System.Linq;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters; using Microsoft.AspNetCore.Mvc.Filters;
using YYApi.Communications; using SimApi.Communications;
using YYApi.Exceptions; using SimApi.Exceptions;
namespace YYApi.Attributes namespace SimApi.Attributes
{ {
/// <summary> /// <summary>
/// 检测登录中间件 /// 检测登录中间件
/// </summary> /// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public class YYAuthAttribute : ActionFilterAttribute public class SimApiAuthAttribute : ActionFilterAttribute
{ {
private string[] Types { get; } private string[] Types { get; }
//默认是user登录类型 //默认是user登录类型
public YYAuthAttribute() public SimApiAuthAttribute()
{ {
Types = new[] { "user" }; Types = new[] { "user" };
} }
//只检测一种用户类型的快捷方式 //只检测一种用户类型的快捷方式
public YYAuthAttribute(string type) public SimApiAuthAttribute(string type)
{ {
Types = new[] { type }; Types = new[] { type };
} }
//设定特定类型的检测 //设定特定类型的检测
public YYAuthAttribute(string[] types) public SimApiAuthAttribute(string[] types)
{ {
Types = types; Types = types;
} }
//只检测一种用户类型的快捷方式
public SimApiAuthAttribute(string type, string url)
{
Types = new[] { type };
new HttpPostAttribute(url);
}
public override void OnActionExecuting(ActionExecutingContext context) public override void OnActionExecuting(ActionExecutingContext context)
{ {
var loginInfo = (YYLoginItem)context.HttpContext.Items["LoginInfo"]; var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"];
//检测是否登录 //检测是否登录
if (loginInfo == null) if (loginInfo == null)
{ {
throw new YYApiException(401); throw new SimApiException(401);
} }
//检测用户类型 //检测用户类型
if (Types.Intersect(loginInfo.Type).Count() == 0) if (Types.Intersect(loginInfo.Type).Count() == 0)
{ {
throw new YYApiException(403); throw new SimApiException(403);
} }
} }
} }
@@ -1,20 +1,20 @@
using System; using System;
using Swashbuckle.AspNetCore.Annotations; using Swashbuckle.AspNetCore.Annotations;
namespace YYApi.Attributes namespace SimApi.Attributes
{ {
/// <summary> /// <summary>
/// 快捷自定义接口文档类 /// 快捷自定义接口文档类
/// </summary> /// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)] [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class YYDocAttribute : SwaggerOperationAttribute public class SimApiDocAttribute : SwaggerOperationAttribute
{ {
/// <summary> /// <summary>
/// 定义接口说明 /// 定义接口说明
/// </summary> /// </summary>
/// <param name="tag">接口分组</param> /// <param name="tag">接口分组</param>
/// <param name="name">接口名称</param> /// <param name="name">接口名称</param>
public YYDocAttribute(string tag, string name) public SimApiDocAttribute(string tag, string name)
{ {
Tags = new[] { tag }; Tags = new[] { tag };
Summary = name; Summary = name;
@@ -1,10 +1,10 @@
using System; using System;
namespace YYApi.Communications namespace SimApi.Communications
{ {
/// <summary> /// <summary>
/// 只有ID的请求 /// 只有ID的请求
/// </summary> /// </summary>
public class YYIdOnlyRequest public class SimApiIdOnlyRequest
{ {
public int Id { get; set; } public int Id { get; set; }
} }
@@ -12,7 +12,7 @@ namespace YYApi.Communications
/// <summary> /// <summary>
/// 基础分页请求 /// 基础分页请求
/// </summary> /// </summary>
public class YYBasePageRequest public class SimApiBasePageRequest
{ {
public int Page { get; set; } public int Page { get; set; }
public int Count { get; set; } public int Count { get; set; }
@@ -2,12 +2,12 @@
using System.Text.Json; using System.Text.Json;
using System.Text.Json.Serialization; using System.Text.Json.Serialization;
namespace YYApi.Communications namespace SimApi.Communications
{ {
/// <summary> /// <summary>
/// 基础相应 /// 基础相应
/// </summary> /// </summary>
public class YYBaseResponse public class SimApiBaseResponse
{ {
/// <summary> /// <summary>
/// 错误代码 /// 错误代码
@@ -36,7 +36,7 @@ namespace YYApi.Communications
/// <summary> /// <summary>
/// 返回一个成功的空结果 /// 返回一个成功的空结果
/// </summary> /// </summary>
public YYBaseResponse() public SimApiBaseResponse()
{ {
SetCode(200); SetCode(200);
} }
@@ -46,7 +46,7 @@ namespace YYApi.Communications
/// 返回指定代码的描述 /// 返回指定代码的描述
/// </summary> /// </summary>
/// <param name="code">错误代码</param> /// <param name="code">错误代码</param>
public YYBaseResponse(int code) public SimApiBaseResponse(int code)
{ {
SetCode(code); SetCode(code);
} }
@@ -56,7 +56,7 @@ namespace YYApi.Communications
/// </summary> /// </summary>
/// <param name="code">错误代码</param> /// <param name="code">错误代码</param>
/// <param name="message">错误信息</param> /// <param name="message">错误信息</param>
public YYBaseResponse(int code, string message) public SimApiBaseResponse(int code, string message)
{ {
SetCodeMsg(code, message); SetCodeMsg(code, message);
} }
@@ -104,7 +104,7 @@ namespace YYApi.Communications
/// 动态内容分页 /// 动态内容分页
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public class YYBasePageResponse<T> : YYBaseResponse public class SimApiBasePageResponse<T> : SimApiBaseResponse
{ {
/// <summary> /// <summary>
/// 动态内容列表 /// 动态内容列表
@@ -122,7 +122,7 @@ namespace YYApi.Communications
/// 动态Data返回 /// 动态Data返回
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public class YYBaseResponse<T> : YYBaseResponse public class SimApiBaseResponse<T> : SimApiBaseResponse
{ {
/// <summary> /// <summary>
/// 动态内容列表 /// 动态内容列表
@@ -1,10 +1,10 @@
using System; using System;
namespace YYApi.Communications namespace SimApi.Communications
{ {
/// <summary> /// <summary>
/// 登录信息中间件 /// 登录信息中间件
/// </summary> /// </summary>
public class YYLoginItem public class SimApiLoginItem
{ {
//登录用户的ID //登录用户的ID
public int Id { get; set; } public int Id { get; set; }
@@ -1,11 +1,12 @@
using YYApi.Communications; using SimApi.Communications;
using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters; using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.ModelBinding; using Microsoft.AspNetCore.Mvc.ModelBinding;
using System.Linq; using System.Linq;
using YYApi.Exceptions; using SimApi.Exceptions;
using SimApi.Attributes;
namespace YYApi.Controllers namespace SimApi.Controllers
{ {
/// <summary> /// <summary>
/// 基础控制器,所有控制器均继承本控制器 /// 基础控制器,所有控制器均继承本控制器
@@ -13,12 +14,12 @@ namespace YYApi.Controllers
/// 2. 报错返回 /// 2. 报错返回
/// 3. 错误回馈页面 /// 3. 错误回馈页面
/// </summary> /// </summary>
public class YYBaseController : Controller public class SimApiBaseController : Controller
{ {
/// <summary> /// <summary>
/// 当前登录用户的ID /// 当前登录用户的ID
/// </summary> /// </summary>
protected YYLoginItem LoginInfo => (YYLoginItem)HttpContext.Items["LoginInfo"]; protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"];
/// <summary> /// <summary>
/// 验证请求参数 /// 验证请求参数
@@ -46,9 +47,9 @@ namespace YYApi.Controllers
/// <param name="code">错误代码</param> /// <param name="code">错误代码</param>
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param> /// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
/// <returns></returns> /// <returns></returns>
protected static void Error(int code = 500, string message = "") protected static void Error(int code = 500, string message = "服务器错误")
{ {
throw new YYApiException(code, message); throw new SimApiException(code, message);
} }
/// <summary> /// <summary>
@@ -57,7 +58,7 @@ namespace YYApi.Controllers
/// <param name="condition">检测条件</param> /// <param name="condition">检测条件</param>
/// <param name="code">错误代码</param> /// <param name="code">错误代码</param>
/// <param name="message">错误描述</param> /// <param name="message">错误描述</param>
protected static void ErrorWhen(bool condition, int code = 500, string message = "") protected static void ErrorWhen(bool condition, int code = 500, string message = "服务器错误")
{ {
if (condition) if (condition)
{ {
@@ -71,28 +72,20 @@ namespace YYApi.Controllers
/// <param name="condition">检测条件</param> /// <param name="condition">检测条件</param>
/// <param name="code">错误代码</param> /// <param name="code">错误代码</param>
/// <param name="message">错误描述</param> /// <param name="message">错误描述</param>
protected static void ErrorWhenNull(object condition, int code = 404, string message = "请求的资源不存在") protected static void ErrorWhenNull(object condition, int code = 404, string message = "资源不存在")
{ {
ErrorWhen(condition == null, code, message); ErrorWhen(condition == null, code, message);
} }
/// <summary> /// <summary>
/// 错误回馈页面 /// 上传文件
/// </summary> /// </summary>
/// <param name="code">错误代码</param>
/// <returns></returns> /// <returns></returns>
[HttpGet("exception/{code:int}")] protected SimApiBaseResponse<string> UploadFile()
[ApiExplorerSettings(IgnoreApi = true)]
public YYBaseResponse ExceptionHandler(int code)
{ {
var response = new YYBaseResponse(); return new SimApiBaseResponse<string>();
response.SetCode(code);
return response;
} }
protected YYBaseResponse<string> UploadFile()
{
return new YYBaseResponse<string>();
}
} }
} }
+60
View File
@@ -0,0 +1,60 @@
using System;
using Microsoft.AspNetCore.Mvc;
using SimApi.Attributes;
using SimApi.Communications;
using SimApi.Helpers;
namespace SimApi.Controllers
{
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();
}
}
}
@@ -1,14 +1,14 @@
using System; using System;
namespace YYApi.Exceptions namespace SimApi.Exceptions
{ {
/// <summary> /// <summary>
/// Api错误捕获异常 /// Api错误捕获异常
/// </summary> /// </summary>
public class YYApiException : Exception public class SimApiException : Exception
{ {
public int Code { get; } public int Code { get; }
public YYApiException(int code, string message = "") : base(message) public SimApiException(int code, string message = "") : base(message)
{ {
Code = code; Code = code;
} }
+65
View File
@@ -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);
}
}
}
}
@@ -2,9 +2,9 @@
using System.IO; using System.IO;
using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.Hosting;
namespace YYApi.Helpers namespace SimApi.Helpers
{ {
public class YYUpload public class SimApiUpload
{ {
private string FilePathFolder = "/uploads/"; private string FilePathFolder = "/uploads/";
public string FilePath public string FilePath
@@ -28,11 +28,17 @@ namespace YYApi.Helpers
private IWebHostEnvironment Env { get; } private IWebHostEnvironment Env { get; }
public YYUpload(IWebHostEnvironment env) public SimApiUpload(IWebHostEnvironment env)
{ {
Env = env; Env = env;
} }
public class SimApiUploadInfo
{
public string Path { get; set; }
public int Size { get; set; }
}
/// <summary> /// <summary>
/// 保存base64文件,如果有标头按照标头自动识别 /// 保存base64文件,如果有标头按照标头自动识别
/// </summary> /// </summary>
@@ -41,7 +47,7 @@ namespace YYApi.Helpers
/// <param name="path">存放路径</param> /// <param name="path">存放路径</param>
/// <param name="fileName">文件名</param> /// <param name="fileName">文件名</param>
/// <returns></returns> /// <returns></returns>
public string SaveFile(string base64, string ext = null, string path = null, string fileName = null) public SimApiUploadInfo SaveFile(string base64, string ext = null, string path = null, string fileName = null)
{ {
byte[] bt; byte[] bt;
var filePath = FilePath + path; var filePath = FilePath + path;
@@ -68,15 +74,30 @@ namespace YYApi.Helpers
{ {
bt = Convert.FromBase64String(base64); bt = Convert.FromBase64String(base64);
} }
var fn = fileName + (string.IsNullOrEmpty(ext) ? string.Empty : $".{ext}");
return WriteFile(filePath, fn, bt);
}
/// <summary>
/// 把数据写入文件
/// </summary>
/// <param name="filePath"></param>
/// <param name="fileName"></param>
/// <param name="data"></param>
/// <returns></returns>
public SimApiUploadInfo WriteFile(string filePath, string fileName, byte[] data)
{
var realPath = Directory.GetCurrentDirectory() + "/wwwroot" + filePath; var realPath = Directory.GetCurrentDirectory() + "/wwwroot" + filePath;
if (!Directory.Exists(realPath)) if (!Directory.Exists(realPath))
{ {
Directory.CreateDirectory(realPath); Directory.CreateDirectory(realPath);
} }
var fn = fileName + (string.IsNullOrEmpty(ext) ? string.Empty : $".{ext}"); File.WriteAllBytes(realPath + fileName, data);
File.WriteAllBytes(realPath + fn, bt); return new SimApiUploadInfo
return filePath + fn; {
Path = filePath + fileName,
Size = data.Length
};
} }
} }
} }
+2 -2
View File
@@ -3,9 +3,9 @@ using System.Security.Cryptography;
using System.Text; using System.Text;
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
namespace YYApi.Helpers namespace SimApi.Helpers
{ {
public static class YYUtil public static class SimApiUtil
{ {
/// <summary> /// <summary>
/// 检测手机号是否正确 /// 检测手机号是否正确
-50
View File
@@ -1,50 +0,0 @@
using System;
using System.Text.Json;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Caching.Distributed;
using YYApi.Communications;
namespace YYApi.Helpers
{
/// <summary>
/// 认证助手
/// </summary>
public class YYAuth
{
private IDistributedCache Cache { get; }
public YYAuth(IDistributedCache cache)
{
Cache = cache;
}
/// <summary>
/// 产生一个Token记录并返回Token
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
public string Set(int id, string type = "user")
{
return Set(id, new[] { type });
}
/// <summary>
/// 产生一个TOken并记录用户ID角色[多角色]
/// </summary>
/// <param name="id"></param>
/// <param name="type"></param>
/// <returns></returns>
public string Set(int id, string[] type)
{
var uuid = Guid.NewGuid().ToString();
var loginItem = new YYLoginItem
{
Id = id,
Type = type
};
Cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
return uuid;
}
}
}
-124
View File
@@ -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 YYHFDashboardAuth : IDashboardAuthorizationFilter
{
private IConfiguration _config { get; }
private IDatabase _redis { get; }
public YYHFDashboardAuth(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();
}
}
}
-10
View File
@@ -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; }
}
}
-10
View File
@@ -1,10 +0,0 @@
using System;
namespace YYApi.JobService
{
public class JobStorage
{
public JobStorage()
{
}
}
}
@@ -2,18 +2,18 @@
using System.Threading.Tasks; using System.Threading.Tasks;
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.Distributed;
using YYApi.Communications; using SimApi.Communications;
namespace YYApi.Middlewares namespace SimApi.Middlewares
{ {
/// <summary> /// <summary>
/// 认证信息获取中间件 /// 认证信息获取中间件
/// </summary> /// </summary>
public class YYAuthMiddleware public class SimApiAuthMiddleware
{ {
private RequestDelegate Next { get; } private RequestDelegate Next { get; }
public YYAuthMiddleware(RequestDelegate next) public SimApiAuthMiddleware(RequestDelegate next)
{ {
Next = next; Next = next;
} }
@@ -31,10 +31,10 @@ namespace YYApi.Middlewares
var login = cache.GetString(token); var login = cache.GetString(token);
if (login != null) if (login != null)
{ {
httpContext.Items.Add("LoginInfo", JsonSerializer.Deserialize<YYLoginItem>(login)); httpContext.Items.Add("LoginInfo", JsonSerializer.Deserialize<SimApiLoginItem>(login));
} }
} }
return Next(httpContext); return Next(httpContext);
} }
} }
@@ -1,21 +1,21 @@
using System; using System;
using System.Threading.Tasks; using System.Threading.Tasks;
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http;
using YYApi.Communications; using SimApi.Communications;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using YYApi.Exceptions; using SimApi.Exceptions;
namespace YYApi.Middlewares namespace SimApi.Middlewares
{ {
/// <summary> /// <summary>
/// 异常处理中间件 /// 异常处理中间件
/// </summary> /// </summary>
public class YYExceptionMiddleware public class SimApiExceptionMiddleware
{ {
private RequestDelegate Next { get; } private RequestDelegate Next { get; }
private ILogger<YYExceptionMiddleware> Log { get; } private ILogger<SimApiExceptionMiddleware> Log { get; }
public YYExceptionMiddleware(RequestDelegate next, ILogger<YYExceptionMiddleware> log) public SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
{ {
Log = log; Log = log;
Next = next; Next = next;
@@ -23,14 +23,26 @@ namespace YYApi.Middlewares
public async Task InvokeAsync(HttpContext context) public async Task InvokeAsync(HttpContext context)
{ {
var response = new YYBaseResponse(); if (context.Request.Headers.ContainsKey("Query-Id"))
{
context.Response.Headers["Query-Id"] = context.Request.Headers["Query-Id"];
}
var response = new SimApiBaseResponse();
try try
{ {
await Next(context); await Next(context);
} }
catch (YYApiException ex) catch (SimApiException ex)
{ {
response.SetCodeMsg(ex.Code, ex.Message); if (string.IsNullOrEmpty(ex.Message))
{
response.SetCode(ex.Code);
}
else
{
response.SetCodeMsg(ex.Code, ex.Message);
}
ErrorResponse(context, response); ErrorResponse(context, response);
} }
catch (Exception ex) catch (Exception ex)
@@ -47,7 +59,7 @@ namespace YYApi.Middlewares
/// </summary> /// </summary>
/// <param name="context"></param> /// <param name="context"></param>
/// <param name="response"></param> /// <param name="response"></param>
private void ErrorResponse(HttpContext context, YYBaseResponse response) private void ErrorResponse(HttpContext context, SimApiBaseResponse response)
{ {
context.Response.StatusCode = 200; context.Response.StatusCode = 200;
context.Response.Headers.Add("Content-Type", "application/json"); context.Response.Headers.Add("Content-Type", "application/json");
+10 -9
View File
@@ -9,15 +9,16 @@
```C# ```C#
using Models; using Models;
using SimApi.Controllers;
namespace Controllers namespace Controllers
{ {
public class BaseController : YYApi.Controllers.BaseController public class BaseController : SimApiBaseController
{ {
/// <summary> /// <summary>
/// 获取登录用户信息 /// 获取登录用户信息
/// </summary> /// </summary>
protected LoginInfoItem LoginInfo => (LoginInfoItem) HttpContext.Items["LoginInfo"]; protected SimApiLoginInfoItem LoginInfo => (SimApiLoginInfoItem) HttpContext.Items["LoginInfo"];
} }
} }
``` ```
@@ -27,32 +28,32 @@ namespace Controllers
```C# ```C#
#Startup.cs #Startup.cs
services.AddYYDoc("文档名称", "文档描述"); services.AddSimApiDoc("文档名称", "文档描述");
app.UseYYDoc("名称",SubmitMethod[]) app.UseSimApiDoc("名称",SubmitMethod[])
#控制器中可以直接使用特性 #控制器中可以直接使用特性
[YYDoc("分组","名称")] [SimApiDoc("分组","名称")]
``` ```
3. 简单的基于Redis的登录TOKEN服务 3. 简单的基于Redis的登录TOKEN服务
```C# ```C#
#Startup.cs #Startup.cs
service.AddYYAuth(); service.AddSimApiAuth();
``` ```
添加时候, 可以从DI中获取 Auth 类,调用 Auth.Set(int,string) 将用户ID/类型和生成的Token绑定,本方法返回缓存中的Key名称 添加时候, 可以从DI中获取 Auth 类,调用 Auth.Set(int,string) 将用户ID/类型和生成的Token绑定,本方法返回缓存中的Key名称
```C# ```C#
#Startup.cs #Startup.cs
app.UseYYAuth(); app.UseSimApiAuth();
``` ```
调用本中间件,然后再需要登录认证的地方,使用 [YYAuth] 特性,即可完成检测登录相关的操作, 调用本中间件,然后再需要登录认证的地方,使用 [YYAuth] 特性,即可完成检测登录相关的操作,
如果需要获取用户的ID, 只需要 直接使用 LoginId 属性即可获取 如果需要获取用户的ID, 只需要 直接使用 LoginId 属性即可获取
4. 统一返回 4. 统一返回
所有Response 均需要继承 BaseResponse类 所有Response 均需要继承 SimApiBaseResponse类
5. 异常处理 5. 异常处理
@@ -60,5 +61,5 @@ app.UseYYAuth();
```C# ```C#
#Startup.cs #Startup.cs
app.UseYYException(); app.UseSimApiException();
``` ```
+10 -10
View File
@@ -1,34 +1,34 @@
<Project Sdk="Microsoft.NET.Sdk.Web"> <Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup> <PropertyGroup>
<TargetFramework>netcoreapp3.1</TargetFramework> <TargetFramework>netcoreapp5.0</TargetFramework>
<OutputType>Library</OutputType> <OutputType>Library</OutputType>
<PackOnBuild>true</PackOnBuild> <PackOnBuild>true</PackOnBuild>
<Version>0.2.3</Version> <Version>0.2.3</Version>
<Authors>xRain@YYTech</Authors> <Authors>xRain@SimcuTeam</Authors>
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description> <Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
<PackageId>YY-Tech.YYApi</PackageId> <PackageId>Simcu.SimApi</PackageId>
<IsPackable>true</IsPackable> <IsPackable>true</IsPackable>
<SymbolPackageFormat>snupkg</SymbolPackageFormat> <SymbolPackageFormat>snupkg</SymbolPackageFormat>
<IncludeSymbols>true</IncludeSymbols> <IncludeSymbols>true</IncludeSymbols>
<ReleaseVersion>5.0.0</ReleaseVersion>
<SynchReleaseVersion>false</SynchReleaseVersion>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageVersion>5.0.2</PackageVersion>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(RunConfiguration)' == 'YYApi' " />
<ItemGroup> <ItemGroup>
<Folder Include="Helpers\" /> <Folder Include="Helpers\" />
<Folder Include="Communications\" /> <Folder Include="Communications\" />
<Folder Include="Controllers\" /> <Folder Include="Controllers\" />
<Folder Include="JobService\" />
<Folder Include="Middlewares\" /> <Folder Include="Middlewares\" />
<Folder Include="Attributes\" /> <Folder Include="Attributes\" />
<Folder Include="Exceptions\" /> <Folder Include="Exceptions\" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.0.0" /> <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.6.3" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.0.0" /> <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.6.3" />
<PackageReference Include="HangFire.Core" Version="1.7.9" />
<PackageReference Include="Hangfire.AspNetCore" Version="1.7.9" />
<PackageReference Include="Hangfire.Console" Version="1.4.2" />
<PackageReference Include="Hangfire.Redis.StackExchange" Version="1.8.1" />
</ItemGroup> </ItemGroup>
<ProjectExtensions> <ProjectExtensions>
<MonoDevelop> <MonoDevelop>
+35 -28
View File
@@ -1,44 +1,47 @@
using System; using System;
using YYApi.Helpers; using SimApi.Helpers;
using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection;
using Microsoft.OpenApi.Models; using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerUI; using Swashbuckle.AspNetCore.SwaggerUI;
using YYApi.Middlewares; using SimApi.Middlewares;
namespace YYApi namespace SimApi
{ {
/// <summary> /// <summary>
/// 加入系统的扩展信息 /// 加入系统的扩展信息
/// </summary> /// </summary>
public static class Extensions public static class Extensions
{ {
public static string DocumentTitle = "";
public static string DocumentDescription = "";
//**********快捷添加************** //**********快捷添加**************
/// <summary> /// <summary>
/// 添加整个YYAPI,同时增加CORS规则 /// 添加整个SimAPI,同时增加CORS规则
/// </summary> /// </summary>
/// <param name="builder"></param> /// <param name="builder"></param>
/// <param name="title"></param> /// <param name="title"></param>
/// <param name="description"></param> /// <param name="description"></param>
/// <returns></returns> /// <returns></returns>
public static IServiceCollection AddYYApi(this IServiceCollection builder, string title, public static IServiceCollection AddSimApi(this IServiceCollection builder, string title,
string description = null) string description = null)
{ {
return builder.AddYYAuth().AddYYDoc(title, description).AddCors().AddYYUpload(); return builder.AddSimApiAuth().AddSimApiDoc(title, description).AddCors().AddSimApiUpload();
} }
/// <summary> /// <summary>
/// 使用所有YYApi自定义中间件 /// 使用所有SimApi自定义中间件
/// </summary> /// </summary>
/// <param name="builder"></param> /// <param name="builder"></param>
/// <param name="title"></param> /// <param name="title"></param>
/// <param name="staticFileroot"></param> /// <param name="staticFileroot"></param>
/// <param name="submitMethods"></param> /// <param name="submitMethods"></param>
/// <returns></returns> /// <returns></returns>
public static IApplicationBuilder UseYYApi(this IApplicationBuilder builder, string title = "API文档", params SubmitMethod[] submitMethods) public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder, params SubmitMethod[] submitMethods)
{ {
return builder.UseYYException().UseYYDoc(title, submitMethods).UseMiddleware<YYAuthMiddleware>().UseCors(x => x.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin()).UseYYUpload(); return builder.UseSimApiException().UseSimApiDoc(submitMethods).UseMiddleware<SimApiAuthMiddleware>().UseCors(x => x.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin()).UseSimApiUpload();
} }
@@ -50,9 +53,9 @@ namespace YYApi
/// </summary> /// </summary>
/// <param name="builder"></param> /// <param name="builder"></param>
/// <returns></returns> /// <returns></returns>
public static IServiceCollection AddYYAuth(this IServiceCollection builder) public static IServiceCollection AddSimApiAuth(this IServiceCollection builder)
{ {
return builder.AddScoped<YYAuth>(); return builder.AddScoped<SimApiAuth>();
} }
/// <summary> /// <summary>
@@ -60,9 +63,9 @@ namespace YYApi
/// </summary> /// </summary>
/// <param name="builder"></param> /// <param name="builder"></param>
/// <returns></returns> /// <returns></returns>
public static IServiceCollection AddYYUpload(this IServiceCollection builder) public static IServiceCollection AddSimApiUpload(this IServiceCollection builder)
{ {
return builder.AddSingleton<YYUpload>(); return builder.AddSingleton<SimApiUpload>();
} }
/// <summary> /// <summary>
@@ -72,12 +75,14 @@ namespace YYApi
/// <param name="title">文档标题</param> /// <param name="title">文档标题</param>
/// <param name="description">文档描述</param> /// <param name="description">文档描述</param>
/// <returns></returns> /// <returns></returns>
public static IServiceCollection AddYYDoc(this IServiceCollection builder, string title, public static IServiceCollection AddSimApiDoc(this IServiceCollection builder, string title,
string description = null) string description = null)
{ {
DocumentTitle = title;
DocumentDescription = description;
return builder.AddSwaggerGen(x => return builder.AddSwaggerGen(x =>
{ {
x.SwaggerDoc("api", new OpenApiInfo { Title = title, Description = description }); x.SwaggerDoc("api", new OpenApiInfo { Title = DocumentTitle, Description = DocumentDescription });
x.EnableAnnotations(); x.EnableAnnotations();
x.AddSecurityRequirement(new OpenApiSecurityRequirement x.AddSecurityRequirement(new OpenApiSecurityRequirement
{ {
@@ -100,9 +105,9 @@ namespace YYApi
/// </summary> /// </summary>
/// <param name="builder"></param> /// <param name="builder"></param>
/// <returns></returns> /// <returns></returns>
public static IApplicationBuilder UseYYException(this IApplicationBuilder builder) public static IApplicationBuilder UseSimApiException(this IApplicationBuilder builder)
{ {
return builder.UseMiddleware<YYExceptionMiddleware>(); return builder.UseMiddleware<SimApiExceptionMiddleware>();
} }
/// <summary> /// <summary>
@@ -110,9 +115,13 @@ namespace YYApi
/// </summary> /// </summary>
/// <param name="builder"></param> /// <param name="builder"></param>
/// <returns></returns> /// <returns></returns>
public static IApplicationBuilder UseYYUpload(this IApplicationBuilder builder) public static IApplicationBuilder UseSimApiUpload(this IApplicationBuilder builder)
{ {
return builder.UseStaticFiles(); return builder.UseStaticFiles(new StaticFileOptions
{
DefaultContentType = "application/x-msdownload",
ServeUnknownFileTypes = true
});
} }
/// <summary> /// <summary>
@@ -122,14 +131,13 @@ namespace YYApi
/// <param name="title">文档标题</param> /// <param name="title">文档标题</param>
/// <param name="submitMethods">文档支持的提交方式(如果不指定,默认使用POST)</param> /// <param name="submitMethods">文档支持的提交方式(如果不指定,默认使用POST)</param>
/// <returns></returns> /// <returns></returns>
public static IApplicationBuilder UseYYDoc(this IApplicationBuilder builder, string title, public static IApplicationBuilder UseSimApiDoc(this IApplicationBuilder builder, params SubmitMethod[] submitMethods)
params SubmitMethod[] submitMethods)
{ {
return builder.UseSwagger(x => x.RouteTemplate = "docs/{documentName}.json").UseSwaggerUI(x => return builder.UseSwagger(x => x.RouteTemplate = "docs/{documentName}.json").UseSwaggerUI(x =>
{ {
x.RoutePrefix = "docs"; x.RoutePrefix = "docs";
x.DocumentTitle = title; x.DocumentTitle = DocumentTitle;
x.SwaggerEndpoint("/docs/api.json", name: title); x.SwaggerEndpoint("/docs/api.json", name: DocumentTitle);
x.EnableValidator(); x.EnableValidator();
if (submitMethods.Length > 0) if (submitMethods.Length > 0)
{ {
@@ -152,10 +160,9 @@ namespace YYApi
/// <param name="title">文档标题</param> /// <param name="title">文档标题</param>
/// <param name="submitMethods">API提交方式定义</param> /// <param name="submitMethods">API提交方式定义</param>
/// <returns></returns> /// <returns></returns>
public static IApplicationBuilder UseYYDocEx(this IApplicationBuilder builder, string title = "API文档", public static IApplicationBuilder UseSimApiDocEx(this IApplicationBuilder builder, params SubmitMethod[] submitMethods)
params SubmitMethod[] submitMethods)
{ {
return builder.UseYYException().UseYYDoc(title, submitMethods); return builder.UseSimApiException().UseSimApiDoc(submitMethods);
} }
/// <summary> /// <summary>
@@ -163,9 +170,9 @@ namespace YYApi
/// </summary> /// </summary>
/// <param name="builder"></param> /// <param name="builder"></param>
/// <returns></returns> /// <returns></returns>
public static IApplicationBuilder UseYYAuth(this IApplicationBuilder builder) public static IApplicationBuilder UseSimApiAuth(this IApplicationBuilder builder)
{ {
return builder.UseMiddleware<YYAuthMiddleware>(); return builder.UseMiddleware<SimApiAuthMiddleware>();
} }