一、前言

在之前的使用Swagger做Api檔案中，我們已經使用Swagger進行開發介面檔案，以及更加方便的使用，這一轉換，讓更多的介面可以以通俗易懂的方式展現給開發人員，而在后續的內容中，為了對api資源的保護，我們引入了認證授權方案，利用HTTP提供了一套標準的身份驗證框架，服務端可以用來針對客戶端的請求發送質詢(challenge)，客戶端根據質詢提供應答身份驗證憑證，進而實作對資源的保護，

因為之前在使用Swagger的系列中還沒有加身份認證授權這一塊，所以我們使用的介面都是沒有進行資源保護的，而再后續又對認證授權這一塊進行講解又沒有將Swagger好好的利用起來，使得每一次要測驗授權認證的時候，都得使用postman在Hearer請求頭中加入Authorization屬性，導致每測驗一個介面就得輸入一次token令牌來實作認證，重復操作頻繁，降低作業效率，

這個時候，我們剛好發現，Swagger已經幫我們是實作了一次輸入令牌，不同介面多次呼叫，提高效率，這樣，我們就可以將之前的Swagger系列和認證授權系列相結合，

說干就干，，，

二、回顧

Swagger系列：

基于.NetCore3.1系列 —— 使用Swagger做Api檔案 (上篇)

基于.NetCore3.1系列 —— 使用Swagger做Api檔案 (下篇)

基于.NetCore3.1系列 —— 使用Swagger匯出檔案 (番外篇)

基于.NetCore3.1系列 —— 使用Swagger匯出檔案 (補充篇)

JWT認證授權系列：

基于.NetCore3.1系列 —— 認證方案之初步認識JWT

基于.NetCore3.1系列 —— 認證授權方案之JwtBearer認證

基于.NetCore3.1系列 —— 認證授權方案之授權初識

基于.NetCore3.1系列 —— 認證授權方案之授權揭秘 (上篇)

基于.NetCore3.1系列 —— 認證授權方案之授權揭秘 (下篇)

三、開始

3.1. 添加Swagger

這里我們使用之前Swagger系列中的原始碼，可以發現這個在沒有使用配置我們認證授權代碼的情況下，資源api都是處于沒有保護的情況下，任何人都可以呼叫使用，沒有安全性，

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("V1", new OpenApiInfo
                {
                    Version = "V1",   //版本 
                    Title = $"XUnit.Core 介面檔案-NetCore3.1",  //標題
                    Description = $"XUnit.Core Http API v1",    //描述
                    Contact = new OpenApiContact { Name = "艾三元", Email = "", Url = new Uri("http://i3yuan.cnblogs.com") },  
                    License = new OpenApiLicense { Name = "艾三元許可證", Url = new Uri("http://i3yuan.cnblogs.com") }
                });
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程式所在目錄（絕對，不受作業目錄影響，建議采用此方法獲取路徑）
               //var basePath = AppContext.BaseDirectory;
                var xmlPath = Path.Combine(basePath, "XUnit.Core.xml");//這個就是剛剛配置的xml檔案名
                c.IncludeXmlComments(xmlPath);//默認的第二個引數是false,對方法的注釋
                // c.IncludeXmlComments(xmlPath,true); //這個是controller的注釋
            });
            services.AddControllers();
        }

3.2. 添加認證授權

基于之前的認證授權方案系列，我們這一節的認證授權就使用之前使用的基于自定義策略授權的方式，實作授權，

3.2.1. 定義權限策略

定義一個權限策略PermissionRequirement，這個策略并包含一些屬性，

public class PermissionRequirement: IAuthorizationRequirement
{
    public string _permissionName { get; }

    public PermissionRequirement(string PermissionName)
    {
        _permissionName = PermissionName;
    }
}

3.2.2. 再定義一個策略處理類

public class PermissionRequirementHandler : AuthorizationHandler<PermissionRequirement>
{
    protected override Task HandleRequirementAsync(AuthorizationHandlerContext context, PermissionRequirement requirement)
    {
        var role = context.User.FindFirst(c => c.Type == ClaimTypes.Role);
        if (role != null)
        {
            var roleValue = https://www.cnblogs.com/i3yuan/p/role.Value;
            if (roleValue==requirement._permissionName)
            {
                context.Succeed(requirement);
            }
        }
        return Task.CompletedTask;
    }
}

3.2.3. 下面展示了如何將自定義要求添加到策略

（請注意，由于這是自定義要求，因此沒有擴展方法，而必須繼續處理策略物件的整個 Requirements 集合）：

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        //基于自定義策略授權
        services.AddAuthorization(options =>
        {
            options.AddPolicy("customizePermisson",
              policy => policy
                .Requirements
                .Add(new PermissionRequirement("admin")));
        });
        //此外，還需要在 IAuthorizationHandler 型別的范圍內向 DI 系統注冊新的處理程式：
        services.AddScoped<IAuthorizationHandler, PermissionRequirementHandler>();
        // 如前所述，要求可包含多個處理程式，如果為授權層的同一要求向 DI 系統注冊多個處理程式，有一個成功就足夠了，

    }

3.2.4. 應用自定義的策略的特性

指定當前用戶必須是應用對控制器或控制器內的操作，如

   [Authorize(Policy = "customizePermisson")]
    public class MovieController : ControllerBase
    { 
    }

3.3. 添加Swagger鎖

利用Swagger為我們提供的介面，在AddSwaggerGen服務中，添加保護api資源的描述，

  var openApiSecurity = new OpenApiSecurityScheme
  {
      Description = "JWT認證授權，使用直接在下框中輸入Bearer {token}（注意兩者之間是一個空格）\"",
      Name = "Authorization",  //jwt 默認引數名稱
      In = ParameterLocation.Header,  //jwt默認存放Authorization資訊的位置（請求頭）
      Type = SecuritySchemeType.ApiKey
  };

添加請求頭的Header中的token,傳遞到后臺，

c.OperationFilter<SecurityRequirementsOperationFilter>();

開啟加權鎖

c.OperationFilter<AddResponseHeadersFilter>();
c.OperationFilter<AppendAuthorizeToSummaryOperationFilter>();

代碼整合如下：在ConfigureServices服務中

        services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("V1", new OpenApiInfo
            {
                Version = "V1",   //版本 
                Title = $"XUnit.Core 介面檔案-NetCore3.1",  //標題
                Description = $"XUnit.Core Http API v1",    //描述
                Contact = new OpenApiContact { Name = "艾三元", Email = "", Url = new Uri("http://i3yuan.cnblogs.com") },  
                License = new OpenApiLicense { Name = "艾三元許可證", Url = new Uri("http://i3yuan.cnblogs.com") }
            });
            var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程式所在目錄（絕對，不受作業目錄影響，建議采用此方法獲取路徑）
           //var basePath = AppContext.BaseDirectory;
            var xmlPath = Path.Combine(basePath, "XUnit.Core.xml");//這個就是剛剛配置的xml檔案名
           // c.IncludeXmlComments(xmlPath);//默認的第二個引數是false,對方法的注釋
             c.IncludeXmlComments(xmlPath,true); // 這個是controller的注釋
            
			#region 加鎖
            var openApiSecurity = new OpenApiSecurityScheme
            {
                Description = "JWT認證授權，使用直接在下框中輸入Bearer {token}（注意兩者之間是一個空格）\"",
                Name = "Authorization",  //jwt 默認引數名稱
                In = ParameterLocation.Header,  //jwt默認存放Authorization資訊的位置（請求頭）
                Type = SecuritySchemeType.ApiKey
            };

            c.AddSecurityDefinition("oauth2", openApiSecurity);
            c.OperationFilter<AddResponseHeadersFilter>();
            c.OperationFilter<AppendAuthorizeToSummaryOperationFilter>();
            c.OperationFilter<SecurityRequirementsOperationFilter>();
            #endregion
        });