认证功能

SwaggerStudy.Models/Student.cs

@@ -2,6 +2,9 @@
 
 namespace SwaggerStudy.Models
 {
+    /// <summary>
+    /// 学生
+    /// </summary>
     public class Student
     {
         public int Id { get; set; }

SwaggerStudy/Program.cs

@@ -22,7 +22,7 @@ namespace SwaggerStudy
                 .ConfigureWebHostDefaults(webBuilder =>
                 {
                     //测试 Swagger 设置
-                    webBuilder.UseStartup<StartupTest>();
+                    //webBuilder.UseStartup<StartupTest>();
 
                     //不使用 Swagger
                     //webBuilder.UseStartup<Startup>();
@@ -38,6 +38,9 @@ namespace SwaggerStudy
 
                     //使用Newtonsoft替代默认System.Text.Json序列化库
                     //webBuilder.UseStartup<Startup032>();
+
+                    //JwtÈÏÖ¤
+                    webBuilder.UseStartup<Startup04>();
                 });
     }
 }

SwaggerStudy/Startup04.cs

@@ -0,0 +1,148 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using System.Collections.Generic;
+
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+
+using Swashbuckle;
+using Swashbuckle.AspNetCore.Swagger;
+using Swashbuckle.AspNetCore.SwaggerGen;
+using Swashbuckle.AspNetCore.SwaggerUI;
+
+
+using SwaggerStudy.Services;
+using Microsoft.OpenApi.Models;
+using System.Reflection;
+
+namespace SwaggerStudy
+{
+    /// <summary>
+    /// 添加 Jwt认证
+    /// </summary>
+    public class Startup04
+    {
+        public Startup04(IConfiguration configuration)
+        {
+            Configuration = configuration;
+        }
+
+        public IConfiguration Configuration { get; }
+
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services
+                .AddControllers()
+                //配置System.Text.Json选项
+                .AddJsonOptions(jsonOption =>
+                {
+                    //整齐打印：压缩格式(一行)还是整齐格式(换行)
+                    jsonOption.JsonSerializerOptions.WriteIndented = true;
+                    //允许(忽略)对象或数据末尾多余的逗号
+                    jsonOption.JsonSerializerOptions.AllowTrailingCommas = true;
+                    //自定义时间格式转换器
+                    jsonOption.JsonSerializerOptions.Converters.Add(new DatetimeJsonConverter());
+                    //转义字符串编码器：直接显示中文
+                    jsonOption.JsonSerializerOptions.Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Unicode.UnicodeRanges.All);
+                });
+
+            //注册Swagger生成器，定义一个或多个 Swagger 文档
+            services.AddSwaggerGen(setup =>
+            {
+                #region 定义Swagger文档
+                //name参数即为SwaggerUI中SwaggerEndpoint方法参数中的{documentName}
+                //两者必须保持一致，否则异常
+                setup.SwaggerDoc(name: "v1", new OpenApiInfo { Title = "Swagger学习", Version = "第一版" });
+                #endregion
+
+                #region 包含xml注释
+                //var xmlCommentFiles = System.IO.Directory.GetFiles(AppDomain.CurrentDomain.BaseDirectory, $"SwaggerStudy*.xml", System.IO.SearchOption.TopDirectoryOnly);
+                var xmlCommentFiles = System.IO.Directory.GetFiles(AppDomain.CurrentDomain.BaseDirectory, $"{Assembly.GetExecutingAssembly().GetName().Name}*.xml", System.IO.SearchOption.TopDirectoryOnly);
+                foreach (var xmlFile in xmlCommentFiles)
+                {
+                    //includeControllerXmlComments参数：是否启用控制器上的xml注释
+                    setup.IncludeXmlComments(filePath: xmlFile, includeControllerXmlComments: true);
+                }
+                #endregion
+
+                #region 放置接口Auth授权按钮
+                setup.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
+                {
+                    Description = "请输入带有Bearer的Token：Bearer {Token}",
+
+                    //jwt默认的参数名称
+                    Name = "Authorization",
+
+                    //jwt默认存放 Authorization 信息的位置：此处为请求头中
+                    In = ParameterLocation.Header,
+
+                    //验证类型：此处使用Api Key
+                    Type = SecuritySchemeType.ApiKey
+                });
+                #endregion
+
+                #region 指定方案应用范围
+                setup.AddSecurityRequirement(new OpenApiSecurityRequirement
+                {
+                    {
+                        new OpenApiSecurityScheme
+                        {
+                            Reference = new OpenApiReference
+                            {
+                                Id = "Bearer",
+                                Type = ReferenceType.SecurityScheme
+                            }
+                        },
+                        new List<string>()
+                    }
+                });
+                #endregion
+            });
+
+            services.AddTransient<StudentServer>();
+        }
+
+        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+        {
+            if (env.IsDevelopment())
+            {
+                app.UseDeveloperExceptionPage();
+            }
+
+            app.UseStaticFiles();
+
+            //启用 Swagger 中间件
+            app.UseSwagger(setup =>
+            {
+
+            });
+
+            //启用 SwaggerUI 中间件
+            app.UseSwaggerUI(setup =>
+            {
+                #region 添加Swagger JSON端点
+                //必须包含{documentName}即是SwaggerDoc的name参数. 
+                //默认为/swagger/{documentName}/swagger.json
+                setup.SwaggerEndpoint("/swagger/v1/swagger.json", "Swagger学习第一版");
+                #endregion
+
+                setup.InjectJavascript("/swagger/ui/zh_cn.js");
+            });
+
+            app.UseRouting();
+
+            app.UseAuthorization();
+
+            app.UseEndpoints(endpoints =>
+            {
+                endpoints.MapControllers();
+            });
+        }
+    }
+}

SwaggerStudy/SwaggerStudy.csproj

@@ -18,4 +18,8 @@
     <PackageReference Include="Swashbuckle.AspNetCore" Version="5.6.3" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Folder Include="wwwroot\" />
+  </ItemGroup>
+
 </Project>