Compare commits

..
2 Commits
Author SHA1 Message Date
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
5 changed files with 34 additions and 16 deletions
+3 -3
View File
@@ -47,7 +47,7 @@ namespace SimApi.Controllers
/// <param name="code">错误代码</param>
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
/// <returns></returns>
protected static void Error(int code = 500, string message = "")
protected static void Error(int code = 500, string message = "服务器错误")
{
throw new SimApiException(code, message);
}
@@ -58,7 +58,7 @@ namespace SimApi.Controllers
/// <param name="condition">检测条件</param>
/// <param name="code">错误代码</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)
{
@@ -72,7 +72,7 @@ namespace SimApi.Controllers
/// <param name="condition">检测条件</param>
/// <param name="code">错误代码</param>
/// <param name="message">错误描述</param>
protected static void ErrorWhenNull(object condition, int code = 404, string message = "请求的资源不存在")
protected static void ErrorWhenNull(object condition, int code = 404, string message = "资源不存在")
{
ErrorWhen(condition == null, code, message);
}
+4 -1
View File
@@ -55,7 +55,10 @@ namespace SimApi.Helpers
/// <param name="uuid">登陆标识</param>
public void Logout(string uuid)
{
Cache.Remove(uuid);
if (!string.IsNullOrEmpty(uuid))
{
Cache.Remove(uuid);
}
}
}
+13 -1
View File
@@ -23,6 +23,11 @@ namespace SimApi.Middlewares
public async Task InvokeAsync(HttpContext context)
{
if (context.Request.Headers.ContainsKey("Query-Id"))
{
context.Response.Headers["Query-Id"] = context.Request.Headers["Query-Id"];
}
var response = new SimApiBaseResponse();
try
{
@@ -30,7 +35,14 @@ namespace SimApi.Middlewares
}
catch (SimApiException ex)
{
response.SetCodeMsg(ex.Code, ex.Message);
if (string.IsNullOrEmpty(ex.Message))
{
response.SetCode(ex.Code);
}
else
{
response.SetCodeMsg(ex.Code, ex.Message);
}
ErrorResponse(context, response);
}
catch (Exception ex)
+13 -10
View File
@@ -13,6 +13,9 @@ namespace SimApi
/// </summary>
public static class Extensions
{
public static string DocumentTitle = "";
public static string DocumentDescription = "";
//**********快捷添加**************
/// <summary>
@@ -36,9 +39,9 @@ namespace SimApi
/// <param name="staticFileroot"></param>
/// <param name="submitMethods"></param>
/// <returns></returns>
public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder, string title = "API文档", params SubmitMethod[] submitMethods)
public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder, params SubmitMethod[] submitMethods)
{
return builder.UseSimApiException().UseSimApiDoc(title, submitMethods).UseMiddleware<SimApiAuthMiddleware>().UseCors(x => x.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin()).UseSimApiUpload();
return builder.UseSimApiException().UseSimApiDoc(submitMethods).UseMiddleware<SimApiAuthMiddleware>().UseCors(x => x.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin()).UseSimApiUpload();
}
@@ -75,9 +78,11 @@ namespace SimApi
public static IServiceCollection AddSimApiDoc(this IServiceCollection builder, string title,
string description = null)
{
DocumentTitle = title;
DocumentDescription = description;
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.AddSecurityRequirement(new OpenApiSecurityRequirement
{
@@ -126,14 +131,13 @@ namespace SimApi
/// <param name="title">文档标题</param>
/// <param name="submitMethods">文档支持的提交方式(如果不指定,默认使用POST)</param>
/// <returns></returns>
public static IApplicationBuilder UseSimApiDoc(this IApplicationBuilder builder, string title,
params SubmitMethod[] submitMethods)
public static IApplicationBuilder UseSimApiDoc(this IApplicationBuilder builder, params SubmitMethod[] submitMethods)
{
return builder.UseSwagger(x => x.RouteTemplate = "docs/{documentName}.json").UseSwaggerUI(x =>
{
x.RoutePrefix = "docs";
x.DocumentTitle = title;
x.SwaggerEndpoint("/docs/api.json", name: title);
x.DocumentTitle = DocumentTitle;
x.SwaggerEndpoint("/docs/api.json", name: DocumentTitle);
x.EnableValidator();
if (submitMethods.Length > 0)
{
@@ -156,10 +160,9 @@ namespace SimApi
/// <param name="title">文档标题</param>
/// <param name="submitMethods">API提交方式定义</param>
/// <returns></returns>
public static IApplicationBuilder UseSimApiDocEx(this IApplicationBuilder builder, string title = "API文档",
params SubmitMethod[] submitMethods)
public static IApplicationBuilder UseSimApiDocEx(this IApplicationBuilder builder, params SubmitMethod[] submitMethods)
{
return builder.UseSimApiException().UseSimApiDoc(title, submitMethods);
return builder.UseSimApiException().UseSimApiDoc(submitMethods);
}
/// <summary>