为控制器的方法添加必要参数

发布于:2024-09-18 ⋅ 阅读:(209) ⋅ 点赞:(0)

前言:做这个系统时,要求每次调用接口时要传操作人、操作人电脑ip、菜单id,然后计入log。本来前端读取到然后加入请求头,后端写入log即可。但是老大要求后端也要把控必传参数,避免前端忘记。所以就写了这个。IOperationFilter 这个是百度知道的。主要用于在Swagger生成的API文档中动态地添加或修改操作(即API接口)的元数据。

用处:可以自动地为 Swagger/OpenAPI 文档中的非匿名 API 方法添加必要的头部参数描述。下面这个过滤器主要用于在 API 的描述中自动添加一些特定的头部参数,比如 operator(操作人)、menu_id(菜单ID)等,但仅对未标记为匿名访问的方法有效。

    public class AddRequiredHeaderParameter : IOperationFilter 
    {
        public void Apply(OpenApiOperation operation, OperationFilterContext context)
        {
            // 确保有一个参数列表  
            operation.Parameters ??= new List<OpenApiParameter>();

            // 获取当前操作的描述符  
            var controllerActionDescriptor = context.ApiDescription.ActionDescriptor as ControllerActionDescriptor;
            if (controllerActionDescriptor == null)
            {
                // 如果不是控制器动作描述符,则不添加参数  
                return;
            }

            // 检查是否有AllowAnonymous属性(是否允许匿名访问)  
            bool isAnonymous = controllerActionDescriptor.MethodInfo.GetCustomAttributes(inherit: true).OfType<AllowAnonymousAttribute>().Any();

            // 如果不是匿名访问,则添加头部参数  
            if (!isAnonymous)
            {
                //操作人
                operation.Parameters.Add(new OpenApiParameter
                {
                    Name = "operator",
                    In = ParameterLocation.Header,
                    Description = "操作人",
                    Required = true
                }); 
                //菜单ID
                operation.Parameters.Add(new OpenApiParameter
                {
                    Name = "menu_id",
                    In = ParameterLocation.Header,
                    Description = "菜单ID",
                    Required = true
                });
             
            }
        }
    }

还需要在program.cs中

builder.Services.AddSwaggerGen(options =>
{
    options.OperationFilter<AddRequiredHeaderParameter>();
});

网站公告

今日签到

点亮在社区的每一天
去签到