Swagger增加自定义参数
** 先增加自定义参数类 **
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
/// 控制swagger中是否需要添加accesstoken验证
/// </summary>
public class AddAuthTokenHeaderParameter : IOperationFilter
{
/// <summary>
///
/// </summary>
/// <param name="operation"></param>
/// <param name="context"></param>
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
if (operation.Parameters == null) operation.Parameters = new List<OpenApiParameter>();
var attrs = context.ApiDescription.ActionDescriptor.AttributeRouteInfo;
//先判断是否是匿名访问,
var descriptor = context.ApiDescription.ActionDescriptor as ControllerActionDescriptor;
if (descriptor != null)
{
var actionAttributes = descriptor.MethodInfo.GetCustomAttributes(inherit: true);
bool isAnonymous = actionAttributes.Any(a => a is AllowAnonymousAttribute);
//非匿名的方法,链接中添加accesstoken值
if (!isAnonymous)
{
operation.Parameters.Add(new OpenApiParameter
{
//参数名称
Name = "Authorization",
In = ParameterLocation.Query,
Required = true //是否必选
});
}
}
}
}
然后在program里注册 这个是swagger的扩展类
builder.Services.AddSwaggerGen(options =>
{
options.OperationFilter<AddAuthTokenHeaderParameter>();
});