ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token
来源:互联网 发布:mac怎么进入屏保 编辑:程序博客网 时间:2024/06/14 06:19
Swagger 是个好东西,对于前后端分离的网站来说,不仅是提高前后端开发人员沟通效率的利器,也大大方便了后端人员测试 API。有时候,API 中可能需要在 Header 中设置认证参数,比如 authToken,这样的功能我们通常是使用 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跨平台或扫描二维码关注
阅读全文
0 0
- ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token
- 在ASP.NET Core中实现一个Token base的身份认证
- 在ASP.NET Core中使用Angular2,以及与Angular2的Token base身份认证
- asp.net core Swagger JWT
- ASP.NET Core中显示自定义错误页面-增强版
- Swagger Ui 之 .Net Core 上传文件
- asp.net中自定义tooltip的显示
- 在ASP.NET Core Web API上使用Swagger提供API文档
- 在ASP.NET Core Web API上使用Swagger提供API文档
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- .net core 使用Swagger
- ASP.NET Core Web API 描述文档-使用Swagger
- Swagger 自定义UI界面
- 小结:token放在header中好处,HTTP Header详解
- asp.net core mvc中文在浏览器显示乱码,解决办法
- 在ASP.NET ATLAS中创建自定义的BEHAVIOR
- 在asp.net中如何调用自定义类的方法?
- 在asp.net 2.0中使用自定义的provider
- WebSocket in ASP.NET Core
- 博客园官方 NuGet镜像上线试运行
- .NET泛型初探
- 微软称开源.NET吸引了更多开发者
- ASP.NET Core 导入导出Excel xlsx 文件
- ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token
- iava 第二课笔记
- 猴子吃桃(GO和lua实现)
- 一个复杂系统的拆分改造实践
- get√—搜索微信公众号【Dotnet跨平台】指定文章的办法
- 分享我的第一个asp.net core开发过程
- 在收购 Sun 的六年后,Oracle 终于瞄准了 Java 的非付费用户
- 从抵触到力推,.Net Core的成功让微软正视开源
- 图说世界编程语言排行