ASP.NETCore的swaggerUI中缺少authToken字段怎么办
这篇文章主要介绍“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 字段,下面就来介绍解决这个问题的办法。
创建一个过滤器类,内容如下:
///
/// this class is for swagger to generate AuthToken Header filed on swagger UI
///
public class AddAuthTokenHeaderParameter : IOperationFilter{
public void Apply(Operation operation, OperationFilterContext context)
{
if (operation.Parameters == null)
operation.Parameters = new List();
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(); // 手动高亮
});
最后,dotnet run
!
到此,关于“ASP.NET Core的swagger UI中缺少authToken字段怎么办”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注创新互联网站,小编会继续努力为大家带来更多实用的文章!
标题名称:ASP.NETCore的swaggerUI中缺少authToken字段怎么办
浏览地址:http://pwwzsj.com/article/iijhhs.html