在. net core 3.1 WebApi中使用Swagger

编辑于 2020/04/02

基于JWT Bearer验证授权的Swagger

简介

---

书接上文,本篇基于上篇的Swagger讲解在Swagger中添加Jwt Bearer授权验证
JWT授权验证请查看我的这篇文章
从0到1详解Jwt以及在Asp.NetCore 3.1中使用JWT Bearer授权认证

如果你是观看Swagger框架 第一篇然后来看第二篇的话，又对Jwt了解不多的话，请务必观看上面链接的Jwt详解，因为此篇是根据Jwt篇的源码进行添加Swagger讲解的

一. 拉取Jwt源码

---

码云

本篇文章主要讲解Jwt + Swagger,不会过多介绍Git，需要了解相关知识的请自行百度。
使用Https拉取我的博客源码,签出Jwt_Bearer分支即可
git clone https://gitee.com/zyknow/blog_project.git

二. 添加Swagger

---

1. 根据第一篇介绍内容添加Swagger

• 先根据第一篇Swagger添加Swagger，这里就不过多演示了。

2. 修改Startups.cs中的ConfigureServices

public void ConfigureServices(IServiceCollection services)
{
    //注入Appsettings,这样才能在任何地方调用静态方法读取appsettings.json
    services.AddSingleton(new Appsettings(Env.ContentRootPath));

    services.AddControllers();

    #region Swagger
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo
        {
            Version = "v0.1.0",
            Title = "Blog.Core API",
            Description = "API文档",
            TermsOfService = new Uri("https://www.jianshu.com/u/1117a3ecacbc"),
            Contact = new OpenApiContact { Name = "Blog.Core", Email = "Blog.Core@xxx.com", Url = new Uri("https://www.jianshu.com/u/1117a3ecacbc") }
        });

        var basePath = AppContext.BaseDirectory;
        var xmlPath = Path.Combine(basePath, "NetCore.Blogs.Demo.xml");//这个就是刚刚配置的xml文件名
        c.IncludeXmlComments(xmlPath, true);



        #region Token绑定到ConfigureServices(以下都是新添加的代码)

        //开启加权小锁
        c.OperationFilter<AddResponseHeadersFilter>();
        c.OperationFilter<AppendAuthorizeToSummaryOperationFilter>();

        //在Header中添加Token
        c.OperationFilter<SecurityRequirementsOperationFilter>();

        //必须是oauth2              
        c.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
        {
            Description = "JWT授权(数据将在请求头中进行传输) 直接在下框中输入Bearer {token}（注意两者之间是一个空格）\"",
            Name = "Authorization",//jwt默认的参数名称
            In = ParameterLocation.Header,//jwt默认存放Authorization信息的位置(请求头中)
            Type = SecuritySchemeType.ApiKey
        });
        #endregion
    });

    #endregion

    #region Jwt注册
    //获取在配置文件中获取Jwt属性设置
    services.AddAuthorizationSetup();
    #endregion

}

三. 运行

---

• 运行结果如下 当我们直接进行请求需要授权接口时，接口请求失败，提示401，如下

  
  401
• 那么要怎么样才能请求验证成功呢

1. 获取Jwt Token

• 在Login界面中请求获取Token

  
  获取Token

2. 添加Token到请求头

• 点击Authorize
  Authorize
• 在Value中输入Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOiJhZG1pbiIsIk5hbWUiOiLmiJHlj6tUdXNlciIsIkFnZSI6IjE4IiwiZXhwIjoxNTg1ODE0NTYwLCJpc3MiOiJ6eWtub3ciLCJhdWQiOiJhdWRpZW5jZSJ9.Ihy51p6VB6Ve_k_stqDQd6Fsi4H8Z9p05ThYMurswHU
  Bearer后面跟刚才去Login控制器获取的Token。
• 输入完成后点击页面下的Authorize就行了。

3. 再次请求受保护的方法

可以看到请求成功了！是不是很简单呢

请求成功

四. 源码

---

拉取后记得切换成Jwt+Swagger分支

码云