ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token
2016-12-20 07:27
1016 查看
Swagger 是个好东西,对于前后端分离的网站来说,不仅是提高前后端开发人员沟通效率的利器,也大大方便了后端人员测试 API。有时候,API 中可能需要在 Header 中设置认证参数,比如 authToken,这样的功能我们通常是使用
创建一个过滤器类,内容如下:
然后在配置 Swagger 的地方,做一些修改:
最后,
这样,Swagger UI 中就显示了附加在 header 中的参数——AuthToken,还要啥 Postman。
相关文章:
在ASP.NET Core Web API上使用Swagger提供API文档
用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
原文地址:http://www.cnblogs.com/JacZhu/p/6188968.html
.NET社区新闻,深度好文,微信中搜索dotNET跨平台或扫描二维码关注
ActionFilter实现的,这就会导致 swagger UI 中缺少 authToken 字段,下面就来介绍解决这个问题的办法。
创建一个过滤器类,内容如下:
/// <summary> /// this class is for swagger to generate AuthToken Header filed on swagger UI /// </summary> public class AddAuthTokenHeaderParameter : IOperationFilter{ public void Apply(Operation operation, OperationFilterContext context) { if (operation.Parameters == null) operation.Parameters = new List<IParameter>(); var attrs = context.ApiDescription.GetActionAttributes(); foreach (var attr in attrs) { // 如果 Attribute 是我们自定义的验证过滤器 if (attr.GetType() == typeof(Auth)) { operation.Parameters.Add(new NonBodyParameter() { Name = "AuthToken", In = "header", Type = "string", Required = false }); } } } }
然后在配置 Swagger 的地方,做一些修改:
services.AddSwaggerGen(c => { c.SingleApiVersion(new Info() { Version = "v1", Title = "API 文档", Description = "系统的 API 文档" }); c.OperationFilter<AddAuthTokenHeaderParameter>(); // 手动高亮 });
最后,
dotnet run!
这样,Swagger UI 中就显示了附加在 header 中的参数——AuthToken,还要啥 Postman。
相关文章:
在ASP.NET Core Web API上使用Swagger提供API文档
用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
原文地址:http://www.cnblogs.com/JacZhu/p/6188968.html
.NET社区新闻,深度好文,微信中搜索dotNET跨平台或扫描二维码关注
相关文章推荐
- ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token
- 在ASP.NET Core中显示自定义的错误页面
- ASP.NET Core中显示自定义错误页面-增强版
- ASP.NET Core中显示自定义错误页面
- asp.net core 自定义中间件和service
- 基于ASP.NET的自定义分页显示
- [Asp.Net]如何在GridView将数字显示成金额格式或自定义格式呢?
- 基于ASP.NET的自定义分页显示
- 学习ASP.NET Core, 怎能不了解请求处理管道[3]: 自定义一个服务器感受一下管道是如何监听、接收和响应请求的
- ASP.NET Core 1.0 静态文件、路由、自定义中间件、身份验证简介
- ASP.NET Core 1.0 静态文件、路由、自定义中间件、身份验证简介
- ASP.NET Core 中文文档 第四章 MVC(3.6.2 )自定义标签辅助类(Tag Helpers)
- asp.net中自定义tooltip的显示
- 如果你想深刻理解ASP.NET Core请求处理管道,可以试着写一个自定义的Server
- 基于ASP.NET的自定义分页显示
- 【无私分享:ASP.NET CORE 项目实战(第八章)】读取配置文件(二) 读取自定义配置文件
- 自定义Alert Confirm对话框[2007-09-07添加显示Progress](需Asp.net Ajax支持)
- 自定义asp.net控件开发之(一)-显示控件内容
- [转]ASP.net MVC 2 自定义模板来显示数据
- 自定义HTTP处理程序显示图片(asp.net 2.0)