.net core 实例教程(十二)配置启用Swagger中的【Authorize】按钮
本文源码下载地址:http://www.80cxy.com/Blog/ResourceView?arId=202403191532545995NAAqJh
系列教程地址:http://www.80cxy.com/Blog/ArticleView?arId=202403191517574161ay3s5V
用户登录成功之后,后台返回JWT格式的token,再后续访问其他接口时需要携带token,为方便Swagger调试,可以开启Swagger的Authorize按钮用于设置接口调用携带的token。默认Swagger不显示Authorize。配置完Swagger页面显示如下:
点击按钮,输入token,注意格式必须在token前面增加“Bearer “字符。
一、配置代码如下:
在SignUp.Common项目JWT文件夹中新增SwaggerGenOptionsExtensions类,代码如下:
using Microsoft.Extensions.DependencyInjection; using Microsoft.OpenApi.Models; using Swashbuckle.AspNetCore.SwaggerGen; namespace SignUp.Common.JWT { public static class SwaggerGenOptionsExtensions { /// <summary> /// 为Swagger增加Authentication报文头 /// </summary> /// <param name="c"></param> public static void AddAuthenticationHeader(this SwaggerGenOptions c) { c.AddSecurityDefinition("Authorization", new OpenApiSecurityScheme { Description = "Authorization header. \r\nExample: 'Bearer 12345abcdef'", Name = "Authorization", In = ParameterLocation.Header, Type = SecuritySchemeType.ApiKey, Scheme = "Authorization" }); c.AddSecurityRequirement(new OpenApiSecurityRequirement() { { new OpenApiSecurityScheme { Reference = new OpenApiReference { Type = ReferenceType.SecurityScheme, Id = "Authorization" }, Scheme = "oauth2", Name = "Authorization", In = ParameterLocation.Header, }, new List<string>() } }); } } }
二、启用Swagger中的【Authorize】按钮配置
在WebApplicationBuilderExtensions配置类的ConfigureExtraServices方法增加如下配置代码:
//启用Swagger中的【Authorize】按钮。这样就不用每个项目的AddSwaggerGen中单独配置了 services.Configure<SwaggerGenOptions>(c => { c.AddAuthenticationHeader(); });
学习交流
附笔者学习 .net core开发时参考相关项目实例源码:asp.net core webapi项目实例源代码锦集下载(72个)
猜您可能还喜欢
- net core+webapi+nginx windows 服务器部署(1321)
- .Nuget Packages 太占C盘,删除后可以放到其他盘(1194)
- ASP.NET Core 配置 Swagger 显示接口注释描述信息(1094)
- vue调用接口后获取不到后端返回的Header响应头(963)
- .net core 系列实例开发教程-权限管理系统功能介绍(951)
- .net core 6.0 web API + SwaggerUI + IIS部署(911)
- .net core 实例教程(十二)配置启用Swagger中的【Authorize】按钮(831)
- .net core 实例教程(一)新建项目(795)
- .net core 实例教程(十四)配置 Swagger 显示接口注释描述信息及支持版本控制(781)
- .net 6中使用log4net写sqlserver数据库日志(755)
评论列表
发表评论
文章分类
文章归档
- 2025年3月 (1)
- 2024年6月 (2)
- 2024年5月 (2)
- 2024年4月 (4)
- 2024年3月 (30)
- 2024年1月 (4)
- 2023年12月 (2)
- 2023年11月 (4)
- 2023年10月 (4)
- 2023年9月 (6)
- 2023年3月 (2)
- 2023年2月 (1)
- 2023年1月 (1)
- 2022年12月 (1)
- 2022年9月 (21)
- 2022年8月 (10)
- 2022年7月 (3)
- 2022年4月 (1)
- 2022年3月 (13)
- 2021年8月 (1)
- 2021年3月 (1)
- 2020年12月 (42)
- 2020年11月 (7)
- 2020年10月 (5)
- 2020年8月 (1)
- 2020年6月 (1)
- 2020年3月 (2)
- 2019年12月 (8)
- 2019年11月 (3)
- 2019年9月 (1)
- 2019年4月 (1)
- 2019年3月 (6)
- 2019年2月 (1)
- 2018年7月 (7)
阅读排行
- 1.asp.net mvc内微信pc端、H5、JsApi支付方式总结(5702)
- 2.各大搜索网站网站收录提交入口地址(3201)
- 3.Windows 10休眠文件更改存储位置(3162)
- 4.ECharts仪表盘实例及参数使用详解(3095)
- 5.windows 10安装myeclipse 10破解补丁cracker.jar、run.bat闪退解决办法(2991)
- 6.HTML5 WebSocket与C#建立Socket连接实现代码(2865)
- 7.华为鸿蒙系统清除微信浏览器缓存方法(2777)
- 8.CERT_HAS_EXPIRED错误如何解决(2239)
- 9.Js异步async、await关键字详细介绍(lambda表达式中使用async和await关键字)(2187)
- 10.HBuilder编辑器格式化代码(2118)