.NET Core Web——注册跨域、Swagger服务、Jwt服务

已于 2023-11-15 15:41:45 修改
阅读量471 收藏 4
点赞数 3
分类专栏： .NET 笔记 文章标签： c# asp.net .net
于 2020-12-22 17:27:47 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40353416/article/details/111521154
版权

.NET Core 3.1 Startup类相关配置（注册跨域、Swagger服务、Jwt服务）

创建ASP.NET Core Web应用程序

创建过程中，我这里选的是.NET Core 3.1   API（没有勾选HTTPS配置）
  • Startup类默认配置

在这里插入图片描述

一. 跨域配置

Startup类，在配置服务的 ConfigureServices(IServiceCollection services) 方法中注册跨域

	  // 注册跨域配置
	  services.AddCors(ky =>
	   {
	       ky.AddPolicy("cors", yx =>
	       {
	           yx.WithOrigins("http://*.*.*.*") // 指定的来源加入原则。
	           .AllowAnyHeader() // 允许任何标题
	           .AllowAnyMethod() // 运行任何方法
	           .AllowAnyOrigin();// 允许任何来源的主机访问
	       });
	   });
  • 在 配置 Configure(IApplicationBuilder app, IWebHostEnvironment env)
    方法中启用跨域服务
	// 启用跨域服务
     app.UseCors("cors");

二. 注册Swagger服务

1.安装NuGet包

  • 注册Swagger服务之前，需安装相应的NuGet包 Swashbuckle.AspNetCoreI
    直接在NuGet包管理器中搜索 swagger 来找到，点击安装即可

在这里插入图片描述

2.注册、启用服务

  • 安装后，在配置服务中注册swagger
       // 注册swagger生成器，定义一个或者多个Swagger文档
       services.AddSwaggerGen(sw =>
        {
            sw.SwaggerDoc("v1", new OpenApiInfo { Title = "MES 系统 Api 接口", Version = "v1", Description = "基于 .NET Core 3.1 的Api" });
            // 获取xml文件路径
            var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
            var xmlPath = Path.Combine(basePath, "MyApi.xml");
            // 加载xml文件（为Swagger JSON and UI 设置xml文档注释路径）
            sw.IncludeXmlComments(xmlPath, true);
        });
  • 在配置中，启用swagger
		// 启用swagger
         app.UseSwagger();
         // 启用swaggerUI
         app.UseSwaggerUI(options =>
         {
             options.SwaggerEndpoint("/swagger/v1/swagger.json", "");
         });

3.生成xml文件，及其他操作

  • swagger服务注册和启用后，需要右击项目，点击属性，点击生成，勾选XML文档文件，图示

在这里插入图片描述
在这里插入图片描述

最后在项目中点击Properties，打开launchSettings.json文件，更改启动后的默认显示路径，如果不需要运行后默认显示swagger的界面，为空字符就行；需要显示其他页面，改成其他的路径即可

  • 直接上图：

在这里插入图片描述

**

之后使用 IIS Express
启动项目，会自动进入Swagger界面，创建了控制器后会显示控制器中的API接口，可以直接在界面中调用接口。

**

  • 来一张比较凌乱的图片：

在这里插入图片描述

三. 配置Jwt

1.安装相应 NuGet 包

包版本及说明
Microsoft.AspNetCore.Authentication.JwtBearer我的项目框架是 .NET Core 3.1，不能安装最新的版本，最高只能安装到3.1.10
Microsoft.IdentityModel.Tokens到目前为止，可以安装到最新版 6.8.0
System.IdentityModel.Tokens.Jwt到目前为止，可以安装到最新版 6.8.0

2.注册 Jwt 服务

  • 配置服务中注册 Jwt 服务代码
			#region 注册jwt相关服务
            // 设置添加身份验证
            services.AddAuthentication(options =>
            {
                //默认身份验证方案
                options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;// 承载身份验证使用的默认值
                options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
            }).AddJwtBearer(options =>
            {
                // 获取或设置用于验证标识标记的参数
                options.TokenValidationParameters = new TokenValidationParameters
                {
                    // 验证颁发者
                    ValidateIssuer = true,
                    // 验证访问者
                    ValidateAudience = true,
                    // 验证生存期
                    ValidateLifetime = true,
                    // 验证使用者的签名秘钥
                    ValidateIssuerSigningKey = true,
                    // 设置颁发者
                    ValidIssuer = "MyIssue",
                    // 设置访问者
                    ValidAudience = "MyAudience",
                     //在验证令牌生命周期时间到后，立即过期；默认的是300秒
                     //默认是300秒，也就是5分钟后，假如生命周期设置的是30秒，还需要加上这300秒
                    ClockSkew = TimeSpan.Zero,
                    //设置秘钥------返回令牌对称安全密钥的新实例
                    IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("873D82D99180B30807F4DA6893369D88"))
                };

                // 身份验证处理过程的控制相关事件
                options.Events = new JwtBearerEvents()
                {
                    // 第一次收到协议消息时调用
                    OnMessageReceived = context =>
                    {
                         //从请求头中获取token
                        string token = context.Request.Headers["token"];
                        //token是否为空字符，null或者空白字符
                       	if (!string.IsNullOrWhiteSpace(token))
                        {
                            context.Token = token;//这里拿到token后会自动验证
                        }
                        return Task.CompletedTask;
                    },
                    // 在将资询发送给回调者之前调用（权限验证失败后触发）
                    OnChallenge = context =>
                    {
                        // 终止.NET Core默认的返回类型和结果
                        context.HandleResponse();
                        // 自定义返回结果
                        var myResult = JsonConvert.SerializeObject(new { code = 401, msg = "抱歉，您无权访问！" });
                        // 自定义返回数据类型
                        context.Response.ContentType = "applic/json";
                        // 自定义返回状态码（默认为200）(我这里改成401)
                        context.Response.StatusCode = StatusCodes.Status401Unauthorized;
                        //输出json数据结果
                        context.Response.WriteAsync(myResult);
                        return Task.FromResult(0);
                    },
                };
            });

            #endregion
  • 启用服务配置
 // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        // 此方法由运行时调用。使用此方法配置HTTP请求管道。
        // 创建应用程序的请求处理管道
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            app.UseRouting();
            // 启用身份验证(我们只需要启用这个)
            app.UseAuthentication();
            // 启用授权（这个默认就存在Startup类中了）
            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });

            // 启用中间件服务生成Swagger作为JSON终结点
            app.UseCors("cors");

            // 启用中间件服务对swagger-ui，指定Swagger JSON终结点
            app.UseSwagger();
            app.UseSwaggerUI(options =>
            {
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "");
            });


        }

3.生成token令牌

  • 创建一个生成令牌的工具类
    public class JwtHelper
    {
        /// <summary>
        /// 创建令牌
        /// </summary>
        /// <param name="claims">指定参数</param>
        /// <returns></returns>
        public static string GenerateToken(Claim[] claims)
        {
            //创建一个加密秘钥（长度在16位以上）——需和Startup类中Jwt配置中设置的秘钥一样
            var secret = "873D82D99180B30807F4DA6893369D88";
            //把秘钥字符串转换成字节数组，创建新的安全键实例
            var securityKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(secret));
            //使用安全键实例创建一个关键的信息，用什么加密算法
            var credentials = new SigningCredentials(securityKey, SecurityAlgorithms.HmacSha256);

            //安全令牌指定参数
            var token = new JwtSecurityToken(
                "MyIssue",//发行者——需和Startup类中Jwt配置中设置的颁发者一样
                "MyAudience",//访问者——需和Startup类中Jwt配置中设置的访问者一样
                claims,
                expires: DateTime.Now.AddDays(1),//令牌过期时间
                signingCredentials: credentials);
            //创建Json Web令牌,安全令牌变成一个小型的JWT序列化格式。
            return new JwtSecurityTokenHandler().WriteToken(token);
        }
    }

4.创建测试代码

  • 新建一个 API 控制器，创建一个登陆方法，一个测试方法
	[Route("api/[controller]/[action]")]
    [ApiController]
    //全局添加了验证标识后，某个方法不需要验证过滤，需要在当前方法上添加一个取消验证的标识  [AllowAnonymous]
    //[Authorize]//添加验证标识，
    public class DefaultController : ControllerBase
    {

        /// <summary>
        /// 登录
        /// </summary>
        /// <param name="accountName">账户名</param>
        /// <param name="accountPwd">账户密码</param>
        /// <returns></returns>
        [HttpPost]
        //[AllowAnonymous] //取消验证，全局添加验证标识后，需要在登录时候添加一个取消验证的标识，不然无法登录。
        public object loginAccount([FromForm]string accountName, [FromForm]string accountPwd)
        {
            try
            {
                var account = new {AccountName="admin",AccountPwd="123456" };
                if (accountName.Equals(account.AccountName) && accountPwd.Equals(account.AccountPwd))
                {
                    //声明 用于创建临牌的参数（自己想加些什么参数就什么）
                    Claim[] claims = new Claim[] {new Claim("accountName",accountName),new Claim("accountPwd",accountPwd) };
                    //调用  Jwthelper 类来创建令牌
                    var token = JwtHelper.GenerateToken(claims);
                    //返回令牌
                    return new {code=200,message="登录成功！",data=new { token,accountName} };
                }
                else
                {
                    return new { code = 200, message = "账号或密码错误！" };
                }
            }
            catch (Exception ex)
            {
                throw ex;
            }
        }


        /// <summary>
        /// 测试一下
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        [Authorize]//添加验证标识
        public object TestToken()
        {
            try
            {               
                return new { code = 200, message = "成功！", data = new {accountName,accountPwd } };
            }
            catch (Exception ex)
            {
                throw ex;
            }
        }
    }

- 测试验证token时候，打断点查看 HttpContext.User.Identity 来的更容易懂

5.开始测试

  • 运行项目后，在swaggerUI界面测试登录

在这里插入图片描述

  • 测试登录，返回token

在这里插入图片描述

  • swaggerUI界面测试，带不了请求头，需要使用Postman来测试，
  • 这是请求头中不带 account_token 参数的请求，会自动进入之前配置中，从而返回自定义的结果，
  • 当前携带的 token 参数不正确的话，也会如此
    -在这里插入图片描述
  • 携带正确的token
  • -在这里插入图片描述

其他

1.设置 API 可自动的动态接收参数

NuGet 包说明
Microsoft.AspNetCore.Mvc.NewtonsoftJson本项目是 .NET Core 3.1版本，最高只能安装3.1.10
  • 在Startup类配置服务中注册
 services.AddControllers().AddNewtonsoftJson();//api可以接受动态参数
  • 登录代码
		/// <summary>
        /// 登录
        /// </summary>
        /// <param name="dy">通过解析操作对象，动态获取参数</param>
        /// <returns></returns>
        [HttpPost]
        public object loginAccount(dynamic dy)
        {
        	//获取账户名名称
            string accountName = dy.accountName.ToString();
            //获取账户密码
            string accountPwd = dy.accountPwd.ToString();
            try
            {
                var account = new { AccountName = "admin", AccountPwd = "123456" };
                if (accountName.Equals(account.AccountName) && accountPwd.Equals(account.AccountPwd))
                {
                    //声明 用于创建临牌的参数（自己想加些什么参数就什么）
                    Claim[] claims = new Claim[] { new Claim("accountName", accountName.ToString()), new Claim("accountPwd", accountPwd.ToString()) };
                    //调用  Jwthelper 类来创建令牌
                    string token = JwtHelper.GenerateToken(claims);
                    //返回令牌
                    return new { code = 200, message = "登录成功！", data = new { token, accountName } };
                }
                else
                {
                    return new { code = 200, message = "账号或密码错误！" };
                }
            }
            catch (Exception ex)
            {
                throw ex;
            }
        }
  • 图示

在这里插入图片描述

完整的Startup配置代码

public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        // 此方法由运行时调用。使用此方法可将服务添加到容器中。
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();

            services.AddControllers().AddNewtonsoftJson();//api可以接受动态参数
            

            #region 跨域配置
            // 注册跨域配置
            services.AddCors(ky =>
            {
                ky.AddPolicy("cors", yx =>
                {
                    yx.WithOrigins("http://*.*.*.*") // 指定的来源加入原则。
                    .AllowAnyHeader() // 允许任何标题
                    .AllowAnyMethod() // 运行任何方法
                    .AllowAnyOrigin();// 允许任何来源的主机访问
                });
            });
            #endregion

            #region Swagger服务
            // 注册swagger生成器，定义一个或者多个Swagger文档
            services.AddSwaggerGen(sw =>
            {
                sw.SwaggerDoc("v1", new OpenApiInfo { Title = "My Test Api 接口", Version = "v1", Description = "基于 .NET Core 3.1 的Api" });

                // 加载xml文件（为Swagger JSON and UI 设置xml文档注释路径）
                // 获取路径
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
                var xmlPath = Path.Combine(basePath, "MyApi.xml");
                sw.IncludeXmlComments(xmlPath, true);
            });
            #endregion

            #region 注册jwt相关服务
            // 设置添加身份验证
            services.AddAuthentication(options =>
            {
                //默认身份验证方案
                options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;// 承载身份验证使用的默认值
                options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
            }).AddJwtBearer(options =>
            {
                // 获取或设置用于验证标识标记的参数
                options.TokenValidationParameters = new TokenValidationParameters
                {
                    // 验证颁发者
                    ValidateIssuer = true,
                    // 验证访问者
                    ValidateAudience = true,
                    // 验证生存期
                    ValidateLifetime = true,
                    // 验证使用者的签名秘钥
                    ValidateIssuerSigningKey = true,
                    // 设置颁发者
                    ValidIssuer = "MyIssuer",
                    // 设置访问者
                    ValidAudience = "MyAudience",
                    //设置秘钥------返回令牌对称安全密钥的新实例
                    IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("873D82D99180B30807F4DA6893369D88"))
                };

                // 身份验证处理过程的控制相关事件
                options.Events = new JwtBearerEvents()
                {
                    // 第一次收到协议消息时调用
                    OnMessageReceived = context =>
                    {
                         //从请求头中获取token
                        string token = context.Request.Headers["token"];
                        //token是否为空字符，null或者空白字符
                       	if (!string.IsNullOrWhiteSpace(token))
                        {
                            context.Token = token;//这里拿到token后会自动验证
                        }
                        return Task.CompletedTask;
                    },
                    // 在将资询发送给回调者之前调用（权限验证失败后触发）
                    OnChallenge = context =>
                    {
                        // 终止.NET Core默认的返回类型和结果
                        context.HandleResponse();
                        // 自定义返回结果
                        var myResult = JsonConvert.SerializeObject(new { code = 401, msg = "抱歉，您无权访问！" });
                        // 自定义返回数据类型
                        context.Response.ContentType = "applic/json";
                        // 自定义返回状态码（默认为200）(我这里改成401)
                        context.Response.StatusCode = StatusCodes.Status401Unauthorized;
                        //输出json数据结果
                        context.Response.WriteAsync(myResult);
                        return Task.FromResult(0);
                    },
                };
            });


            #endregion

        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        // 此方法由运行时调用。使用此方法配置HTTP请求管道。
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseRouting();

            //1.先开启认证
            app.UseAuthentication();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });

            app.UseCors("cors");

            // 启用服务
            app.UseSwagger();
            // 启用服务
            app.UseSwaggerUI(options =>
            {
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "");
            });
        }
    }

结语

新手小白哈，有很多可能没注意到，写的不好，纯属当个人笔记，

在这里插入图片描述

尘世里的琐碎
关注
  • 3
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
为ASP.NET Core Web API生成C＃客户端API
04-12
ASP.NET Core Web API是Microsoft开发的一个强大的框架，用于构建RESTful服务，这些服务可以与各种客户端应用程序（如浏览器、移动应用或桌面应用）交互。在本文中，我们将深入探讨如何为C#和JavaScript（包括jQuery...
.net core6.0 webapi 后端项目框架源码，配置sqlserver数据库连接字符串，开箱即用
05-16
.net core 6.0 webapi Resful风格； 采用仓储+服务+接口的形式封装框架； 基于AOP切面的Redis缓存； 使用 Swagger 做api文档； 使用 Automapper 处理对象映射； 使用 AutoFac 做依赖注入容器，并提供批量服务注入； ...
配置Swagger被JWT拦截，token无效问题
m0_50573190的博客
06-05 968
配置Swagger被JWT拦截，token无效问题
IDEA 新建 JavaWeb 项目（：找不到 Web Application 解决方法）
老男孩的架构路
07-30 8529
由于IDEA版本更新，JavaWeb项目的创建流程也会发生一些变化，这篇文件记录了新建一个JavaWeb项目的全流程，其中包括一些需要注意的细节以及可能发生问题的解决方法，希望能帮到大家。
.NET Core 6.0 注册服务，并创建对象. Scoped声明周期
Answer3664的博客
11-16 1733
使用 .NET Core 6.0进行依赖注入
NET CORE 业务层服务自动注册——DI
最新发布
cjh16606260986的博客
11-10 231
NET CORE 业务层服务自动注册
（二）.net core之依赖注入、服务注册
lwy
11-16 812
Startup:配置web应用所需要得服务和中间件
.net core注册服务的生命周期的三种方式
个人成长记录
04-08 399
1.最基本的注册方式，即在ConfigureServices容器中注册。2.继承接口 ITransientDependency。3.声明Dependency特性。
毕业设计基于Vue和.NET Core Web API 加油站管理系统源码+项目说明.zip
10-16
毕业设计基于Vue和.NET Core Web API 加油站管理系统源码+项目说明.zip 前端：Vue + ElementUI (ElementUI 2.7.2) 后台：.NET Core Web API (.net core 2.2) * 前台采用ElementUI界面风格良好 * 页面提交修改有关...
RESTapi:.NET核心5
03-31
.NET Core 5是微软推出的轻量级、跨平台的开发框架，它支持快速开发高性能的Web服务，包括RESTful API。 1. **ASP.NET Core MVC**：ASP.NET Core MVC框架提供了构建REST API所需的基础架构。通过定义控制器类和动作...
.net core的swagger使用，ADO使用，跨域
07-13
.net core的swagger使用，ADO使用，跨域 .net core ADO.net 操作数据库---查询 https://blog.csdn.net/cplvfx/article/details/107327844 .net core swagger安装 https://blog.csdn.net/cplvfx/article/details/107327632 .net core 跨域 https://blog.csdn.net/cplvfx/article/details/107328012
ASP.NET Core依赖注入系列教程之服务的注册与提供
10-17
主要给大家介绍了关于ASP.NET Core依赖注入系列教程之服务的注册与提供的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起看看吧
.net core使用Jwt授权验证
10-30
.net core使用Jwt授权验证，使用版本为.net core2.2，微软已经集成使用很方便
WebApi
03-09
WebApi是Microsoft为.NET Framework和.NET Core开发的一个用于构建RESTful服务的框架，它使得创建高效、可测试的HTTP服务变得简单。WebApi主要用于构建面向客户端应用程序，如浏览器和移动设备的应用，通过HTTP协议...
nssm将 netCore项目注册成服务。
jrl0920的博客
12-08 483
运行 nssm status Vol.WebApi。可以在windows 服务里面看到服务注册成功并启动。#运行 nssm start Vol.WebApi。在doc窗口执行 nssm 查看命令行。nssm 下载完成解压后在。nssm管网下载地址。
.Net core 泛型服务的注册
Ray
03-25 1149
在.Net core注册一个泛型的服务 public interface IService<T> { async Task DoAction(); } public class Service<T> : IService<T> { public async Task DoAction() { .... do action } } ServiceCollection.AddScoped<typeof(ISer
.NET Core API框架实战（五） 依赖注入 服务的注册与提供
qq_35193189的博客
08-24 6659
ASP.NET Core 的底层设计支持和使用依赖注入。ASP.NET Core 应用程序可以利用内置的框架服务将它们注入到启动类Startup的方法中，并且应用程序服务ConfigureServices能够配置注入。
.NET 6 中将 ASP.NET Core 注册成 Windows Service
寒冰屋的专栏
10-13 830
.NET 6 中将 ASP.NET Core 注册成 Windows Service
ASP.NET Core MVC 2.x 全面教程_ASP.NET Core MVC 03. 服务注册和管道
weixin_30410999的博客
05-23 226
ASP.NET Core MVC 2.x 全面教程_ASP.NET Core MVC 03. 服务注册和管道 语雀： https://www.yuque.com/yuejiangliu/dotnet/olbl88 视频地址：https://www.bilibili.com/video/av38392956/?p=3 自定义接口对象获取信息 现在不想从配置源里面获取信息，自己写一个服务，首...
ASP.NET Web API 身份验证与JWT跨域实践教程
"asp.net基于JWT的web api身份验证及跨域调用实践" ASP.NET Web API 身份验证通常涉及确保只有经过验证的用户能够访问受保护的API资源。JSON Web Token (JWT) 是一种安全的身份验证和授权机制，适用于现代分布式...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值