Net6 Swagger增加自定义参数

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>();

});
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值