Merge branch 'master' of https://github.com/cq-panda/Vue.NetCore

Author: [email protected]

Vue.Net/VOL.WebApi/Startup.cs

@@ -46,7 +46,7 @@ public Startup(IConfiguration configuration)
         // This method gets called by the runtime. Use this method to add services to the container.
         public void ConfigureServices(IServiceCollection services)
         {
-            //初始化模型验证配置
+            //初始化模型验证配置
             services.UseMethodsModelParameters().UseMethodsGeneralParameters();
             services.AddSingleton<IObjectModelValidator>(new NullObjectModelValidator());
             Services = services;
@@ -76,13 +76,13 @@ public void ConfigureServices(IServiceCollection services)
              {
                  options.TokenValidationParameters = new TokenValidationParameters
                  {
-                     SaveSigninToken = true,//保存token,后台验证token是否生效(重要)
-                     ValidateIssuer = true,//是否验证Issuer
-                     ValidateAudience = true,//是否验证Audience
-                     ValidateLifetime = true,//是否验证失效时间
-                     ValidateIssuerSigningKey = true,//是否验证SecurityKey
+                     SaveSigninToken = true,//保存token,后台验证token是否生效(重要)
+                     ValidateIssuer = true,//是否验证Issuer
+                     ValidateAudience = true,//是否验证Audience
+                     ValidateLifetime = true,//是否验证失效时间
+                     ValidateIssuerSigningKey = true,//是否验证SecurityKey
                      ValidAudience = AppSetting.Secret.Audience,//Audience
-                     ValidIssuer = AppSetting.Secret.Issuer,//Issuer，这两项和前面签发jwt的设置一致
+                     ValidIssuer = AppSetting.Secret.Issuer,//Issuer，这两项和前面签发jwt的设置一致
                      IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(AppSetting.Secret.JWT))
                  };
                  options.Events = new JwtBearerEvents()
@@ -93,16 +93,16 @@ public void ConfigureServices(IServiceCollection services)
                          context.Response.Clear();
                          context.Response.ContentType = "application/json";
                          context.Response.StatusCode = 401;
-                         context.Response.WriteAsync(new { message = "授权未通过", status = false, code = 401 }.Serialize());
+                         context.Response.WriteAsync(new { message = "授权未通过", status = false, code = 401 }.Serialize());
                          return Task.CompletedTask;
                      }
                  };
              });
-            //必须appsettings.json中配置
+            //必须appsettings.json中配置
             string corsUrls = Configuration["CorsUrls"];
             if (string.IsNullOrEmpty(corsUrls))
             {
-                throw new Exception("请配置跨请求的前端Url");
+                throw new Exception("请配置跨请求的前端Url");
             }
             services.AddCors(options =>
             {
@@ -118,20 +118,20 @@ public void ConfigureServices(IServiceCollection services)
             services.AddControllers();
             services.AddSwaggerGen(c =>
             {
-                //分为2份接口文档
-                c.SwaggerDoc("v1", new OpenApiInfo { Title = "VOL.Core后台Api", Version = "v1", Description = "这是对文档的描述。。" });
-                c.SwaggerDoc("v2", new OpenApiInfo { Title = "VOL.Core对外三方Api", Version = "v2", Description = "xxx接口文档" });  //控制器里使用[ApiExplorerSettings(GroupName = "v2")]              
-                //启用中文注释功能
-                var basePath = PlatformServices.Default.Application.ApplicationBasePath;
-                var xmlPath = Path.Combine(basePath, "VOL.WebApi.xml");
-                c.IncludeXmlComments(xmlPath, true);//显示控制器xml注释内容
-                //添加过滤器 可自定义添加对控制器的注释描述
+                //分为2份接口文档
+                c.SwaggerDoc("v1", new OpenApiInfo { Title = "VOL.Core后台Api", Version = "v1", Description = "这是对文档的描述。。" });
+                c.SwaggerDoc("v2", new OpenApiInfo { Title = "VOL.Core对外三方Api", Version = "v2", Description = "xxx接口文档" });  //控制器里使用[ApiExplorerSettings(GroupName = "v2")]              
+                //启用中文注释功能
+               // var basePath = PlatformServices.Default.Application.ApplicationBasePath;
+              //  var xmlPath = Path.Combine(basePath, "VOL.WebApi.xml");
+             //   c.IncludeXmlComments(xmlPath, true);//显示控制器xml注释内容
+                //添加过滤器 可自定义添加对控制器的注释描述
                 //c.DocumentFilter<SwaggerDocTag>();
 
                 var security = new Dictionary<string, IEnumerable<string>> { { AppSetting.Secret.Issuer, new string[] { } } };
                 c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme()
                 {
-                    Description = "JWT授权token前面需要加上字段Bearer与一个空格,如Bearer token",
+                    Description = "JWT授权token前面需要加上字段Bearer与一个空格,如Bearer token",
                     Name = "Authorization",
                     In = ParameterLocation.Header,
                     Type = SecuritySchemeType.ApiKey,
@@ -186,7 +186,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             app.UseDefaultFiles();
             app.Use(HttpRequestMiddleware.Context);
 
-            //2021.06.27增加创建默认upload文件夹
+            //2021.06.27增加创建默认upload文件夹
             string _uploadPath = (env.ContentRootPath + "/Upload").ReplacePath();
 
             if (!Directory.Exists(_uploadPath))
@@ -198,24 +198,24 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             {
                 FileProvider = new PhysicalFileProvider(
                 Path.Combine(Directory.GetCurrentDirectory(), @"Upload")),
-                //配置访问虚拟目录时文件夹别名
+                //配置访问虚拟目录时文件夹别名
                 RequestPath = "/Upload",
                 OnPrepareResponse = (Microsoft.AspNetCore.StaticFiles.StaticFileResponseContext staticFile) =>
                 {
-                    //可以在此处读取请求的信息进行权限认证
+                    //可以在此处读取请求的信息进行权限认证
                     //  staticFile.File
                     //  staticFile.Context.Response.StatusCode;
                 }
             });
-            //配置HttpContext
+            //配置HttpContext
             app.UseStaticHttpContext();
 
             app.UseSwagger();
             app.UseSwaggerUI(c =>
             {
-                //2个下拉框选项  选择对应的文档
-                c.SwaggerEndpoint("/swagger/v1/swagger.json", "VOL.Core后台Api");
-                c.SwaggerEndpoint("/swagger/v2/swagger.json", "测试第三方Api");
+                //2个下拉框选项  选择对应的文档
+                c.SwaggerEndpoint("/swagger/v1/swagger.json", "VOL.Core后台Api");
+                c.SwaggerEndpoint("/swagger/v2/swagger.json", "测试第三方Api");
                 c.RoutePrefix = "";
             });
             app.UseRouting();
@@ -225,7 +225,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             app.UseEndpoints(endpoints =>
             {
                 endpoints.MapControllers();
-                //配置SignalR
+                //配置SignalR
                 if (AppSetting.UseSignalR)
                 {
                     string corsUrls = Configuration["CorsUrls"];
@@ -242,22 +242,22 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
     }
 
     /// <summary>
-    /// Swagger注释帮助类
+    /// Swagger注释帮助类
     /// </summary>
     public class SwaggerDocTag : IDocumentFilter
     {
         /// <summary>
-        /// 添加附加注释
+        /// 添加附加注释
         /// </summary>
         /// <param name="swaggerDoc"></param>
         /// <param name="context"></param>
         public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
         {
-            //添加对应的控制器描述
+            //添加对应的控制器描述
             swaggerDoc.Tags = new List<OpenApiTag>
             {
-                new OpenApiTag { Name = "Test", Description = "这是描述" },
-                //new OpenApiTag { Name = "你的控制器名字，不带Controller", Description = "控制器描述" },
+                new OpenApiTag { Name = "Test", Description = "这是描述" },
+                //new OpenApiTag { Name = "你的控制器名字，不带Controller", Description = "控制器描述" },
             };
         }
     }