欢迎来到尧图网

客户服务 关于我们

您的位置:首页 > 财经 > 产业 > .net6 swagger 修改路由名称的过滤器 去除掉后缀的Service

.net6 swagger 修改路由名称的过滤器 去除掉后缀的Service

2025/2/24 20:16:22 来源:https://blog.csdn.net/qq_61596453/article/details/141126264  浏览:    关键词:.net6 swagger 修改路由名称的过滤器 去除掉后缀的Service
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.IO;
using static System.Net.WebRequestMethods;public class RemoveServiceSuffixOperationFilter : IOperationFilter
{/// <summary>/// 修改路由名称的过滤器 去除掉后缀的Service/// </summary>/// <param name="operation"></param>/// <param name="context"></param>public void Apply(OpenApiOperation operation, OperationFilterContext context){if (operation.Tags.Count > 0){foreach (var tag in operation.Tags){tag.Name = tag.Name.Replace("Service", "");}}}
}/// <summary>
/// OpenApi过滤器
/// </summary>
public class TagReorderDocumentFilter : IDocumentFilter
{/// <summary>/// 修改路由名称的过滤器 去除掉后缀的Service/// </summary>/// <param name="operation"></param>/// <param name="context"></param>public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context){//修改模块名称foreach (var tag in swaggerDoc.Tags){tag.Name = tag.Name.Replace("Service", "");}//修改路由中的模块foreach (var path in swaggerDoc.Paths){foreach (var o in path.Value.Operations){foreach (var tag in o.Value.Tags){tag.Name = tag.Name.Replace("Service", "");}}}//swaggerDoc.Tags.Clear(); //清空Tags防止重复//Dictionary<string, OpenApiTag> dic = new Dictionary<string, OpenApiTag>();重新添加Tags//foreach (var path in swaggerDoc.Paths)//{//    foreach (var o in path.Value.Operations)//    {//        foreach (var tag in o.Value.Tags)//        {//            if (!dic.Keys.Contains(tag.Name))//            {//                dic.Add(tag.Name, tag);//                swaggerDoc.Tags.Add(tag);//            }//        }//    }//}}
}

在program.cs中注册

//添加Swagger的Authiozer的按钮鉴权
builder.Services.AddSwaggerGen(s =>
{s.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });string netXmlString = AppContext.BaseDirectory + "/WebApiBasics.Net.xml";s.IncludeXmlComments(netXmlString, true);string entityXmlStringa = AppDomain.CurrentDomain.BaseDirectory + "/WebApiBasics.Entity.xml";s.IncludeXmlComments(entityXmlStringa, true);string coreXmlStringa = AppDomain.CurrentDomain.BaseDirectory + "/WebApiBasics.Core.xml";s.IncludeXmlComments(coreXmlStringa, true);// 添加修改路由名称的过滤器 去除掉后缀的Services.OperationFilter<RemoveServiceSuffixOperationFilter>();s.DocumentFilter<TagReorderDocumentFilter>();s.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme(){Description = "在下框中输入请求头中需要添加Jwt授权Token:Bearer Token",Name = "Authorization",In = ParameterLocation.Header,Type = SecuritySchemeType.ApiKey,BearerFormat = "JWT",Scheme = "Bearer"});s.AddSecurityRequirement(new OpenApiSecurityRequirement{{new OpenApiSecurityScheme{Reference = new OpenApiReference {Type = ReferenceType.SecurityScheme,Id = "Bearer"}},new string[] { }}});});

效果

版权声明:

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

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

热搜词