.NET Core API框架实战（二） Swagger中创建Token头工具并创建Controller描述过滤器DocumentFilter

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

Swagger 是个好东西，对于前后端分离的网站来说，不仅是提高前后端开发人员沟通效率的利器，也大大方便了后端人员测试 API。有时候，API 中可能需要在 Header 中设置认证参数，比如 authToken，这样的功能我们通常是使用【ActionFilter】

实现的，这就会导致 swagger UI 中缺少 authToken 字段，下面就来介绍解决这个问题的办法。

创建一个过滤器类 AuthTokenHeaderParameter，内容如下：

 public class AuthTokenHeaderParameter : IOperationFilter
    {
        public void Apply(Operation operation, OperationFilterContext context)
        {
            operation.Parameters = operation.Parameters ?? new List<IParameter>();
            //MemberAuthorizeAttribute 自定义的身份验证特性标记
            var isAuthor = operation != null && context != null;
            if (isAuthor)
            {
                //in query header 
                operation.Parameters.Add(new NonBodyParameter()
                {
                    Name = "Authenticate",
                    In = "header", //query formData ..
                    Description = "身份验证",
                    Required = false,
                    Type = "string"
                });
            }
        }
    }

然后在配置 Swagger 的地方，做一些修改：

ConfigureServices.cs

  c.OperationFilter<AuthTokenHeaderParameter>();

最后 dotnet run

ASP.NET Core 在 Swagger UI 中显示Controller描述

创建一个过滤器类 AuthApplyTagDescriptions，内容如下：

public class AuthApplyTagDescriptions : IDocumentFilter
    {
        public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
        {
            swaggerDoc.Tags = new List<Tag>
            {
                new Tag{ Name="Account",Description="账户中心接口"},
            };
        }
    }

修改Swagger配置文件

  c.DocumentFilter<AuthApplyTagDescriptions>();

最后 dotnet run 运行