allbetgaming代理:基于.NetCore3.1系列 ——认证授权方案之Swagger加锁

admin 3个月前 (07-15) 科技 49 0

一、前言

在之前的使用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 = 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
        });

c.AddSecurityDefinition("oauth2", openApiSecurity); 这里的方案名称必须是oauth2

四、运行

未加锁的情况下,效果如下:

上锁的程序后,执行后发现,

执行效果

allbetgaming代理:基于.NetCore3.1系列 ——认证授权方案之Swagger加锁 第1张

五、总结

  1. 通过上面的汇总,我们已经实现将Swagger和net core身份认证授权才气接见接口
  2. 在以后测试接口授权的时刻,就可以直接通过Swagger中的锁来调试运行,削减重复添加令牌举行操作。
  3. 源码地址
,

欧博亚洲客户端下载

欢迎进入欧博亚洲客户端下载(Allbet Game):www.aLLbetgame.us,欧博官网是欧博集团的官方网站。欧博官网开放Allbet注册、Allbe代理、Allbet电脑客户端、Allbet手机版下载等业务。

Allbet声明:该文看法仅代表作者自己,与本平台无关。转载请注明:allbetgaming代理:基于.NetCore3.1系列 ——认证授权方案之Swagger加锁

站点信息

  • 文章总数:557
  • 页面总数:0
  • 分类总数:8
  • 标签总数:816
  • 评论总数:149
  • 浏览总数:12186