• ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token


    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

    image_1b447qq7n1ufcnsv6s2u1ar0b9.png-31kB

    这样,Swagger UI 中就显示了附加在 header 中的参数——AuthToken,还要啥 Postman。

  • 相关阅读:
    四月书籍
    iOS 第三方登录之 QQ登录
    百度面试经验之谈 ----------转
    OC浅析一
    书目列表
    UIStroryboard分类
    ios基础笔记(一)
    IOS笔记-代码块(微博项目)-1.0
    IOS控件内容 对齐方式
    android同一个TextView设置不同颜色字体
  • 原文地址:https://www.cnblogs.com/JacZhu/p/6188968.html
Copyright © 2020-2023  润新知