温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

ASP.NET Core的swagger UI中缺少authToken字段怎么办

发布时间:2021-12-06 14:33:18 阅读:297 作者:iii 栏目:大数据
开发者测试专用服务器限时活动,0元免费领,库存有限,领完即止! 点击查看>>

这篇文章主要介绍“ASP.NET Core的swagger UI中缺少authToken字段怎么办”,在日常操作中,相信很多人在ASP.NET Core的swagger UI中缺少authToken字段怎么办问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”ASP.NET Core的swagger UI中缺少authToken字段怎么办”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!

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

到此,关于“ASP.NET Core的swagger UI中缺少authToken字段怎么办”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注亿速云网站,小编会继续努力为大家带来更多实用的文章!

亿速云「云服务器」,即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘,价格低至29元/月。点击查看>>

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

原文链接:https://my.oschina.net/u/3772973/blog/4626097

AI

开发者交流群×