fix error response message, error namespace. now useMiddleware dont need api doc title

This commit is contained in:
2020-08-23 21:42:41 +08:00
parent ba7b3ecd60
commit e4773f3154
4 changed files with 26 additions and 13 deletions
+1 -1
View File
@@ -72,7 +72,7 @@ namespace SimApi.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);
} }
+4 -1
View File
@@ -55,7 +55,10 @@ namespace SimApi.Helpers
/// <param name="uuid">登陆标识</param> /// <param name="uuid">登陆标识</param>
public void Logout(string uuid) public void Logout(string uuid)
{ {
Cache.Remove(uuid); if (!string.IsNullOrEmpty(uuid))
{
Cache.Remove(uuid);
}
} }
} }
+8 -1
View File
@@ -30,7 +30,14 @@ namespace SimApi.Middlewares
} }
catch (SimApiException 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)
+13 -10
View File
@@ -13,6 +13,9 @@ namespace SimApi
/// </summary> /// </summary>
public static class Extensions public static class Extensions
{ {
public static string DocumentTitle = "";
public static string DocumentDescription = "";
//**********快捷添加************** //**********快捷添加**************
/// <summary> /// <summary>
@@ -36,9 +39,9 @@ namespace SimApi
/// <param name="staticFileroot"></param> /// <param name="staticFileroot"></param>
/// <param name="submitMethods"></param> /// <param name="submitMethods"></param>
/// <returns></returns> /// <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, 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
{ {
@@ -126,14 +131,13 @@ namespace SimApi
/// <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 UseSimApiDoc(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)
{ {
@@ -156,10 +160,9 @@ namespace SimApi
/// <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 UseSimApiDocEx(this IApplicationBuilder builder, string title = "API文档", public static IApplicationBuilder UseSimApiDocEx(this IApplicationBuilder builder, params SubmitMethod[] submitMethods)
params SubmitMethod[] submitMethods)
{ {
return builder.UseSimApiException().UseSimApiDoc(title, submitMethods); return builder.UseSimApiException().UseSimApiDoc(submitMethods);
} }
/// <summary> /// <summary>