欢迎来到尧图网

客户服务 关于我们

您的位置:首页 > 房产 > 建筑 > 为控制器的方法添加必要参数

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

2024/10/25 5:20:01 来源:https://blog.csdn.net/m0_50985216/article/details/141998360  浏览:    关键词:为控制器的方法添加必要参数

前言:做这个系统时,要求每次调用接口时要传操作人、操作人电脑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}); //菜单IDoperation.Parameters.Add(new OpenApiParameter{Name = "menu_id",In = ParameterLocation.Header,Description = "菜单ID",Required = true});}}}

还需要在program.cs中

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

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com