我是靠谱客的博主 要减肥大门,最近开发中收集的这篇文章主要介绍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>();
});

最后

以上就是要减肥大门为你收集整理的Net6 Swagger增加自定义参数的全部内容,希望文章能够帮你解决Net6 Swagger增加自定义参数所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错,欢迎将靠谱客网站推荐给程序员好友。

本图文内容来源于网友提供,作为学习参考使用,或来自网络收集整理,版权属于原作者所有。
点赞(49)

评论列表共有 0 条评论

立即
投稿
返回
顶部