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

cs 复制代码
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中注册

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

    // 添加修改路由名称的过滤器 去除掉后缀的Service
    s.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[] { }
                        }
                    });

});

效果

相关推荐
虚行20 分钟前
C#项目连接S7-PLCSIM Advanced读写操作
开发语言·python·c#
“抚琴”的人1 小时前
C#中获取程序执行时间
服务器·前端·c#
薄荷撞~可乐3 小时前
C#拆箱/装箱(性能优化)
性能优化·c#
胖咕噜的稞达鸭4 小时前
C++中的父继子承(2)多继承菱形继承问题,多继承指针偏移,继承组合分析+高质量习题扫尾继承多态
c语言·开发语言·数据结构·c++·算法·链表·c#
喵叔哟4 小时前
7. 从0到上线:.NET 8 + ML.NET LTR 智能类目匹配实战--反馈存储与数据治理:MongoDB 设计与运维
运维·mongodb·.net
Dm_dotnet4 小时前
WPF应用绑定系统快捷键
c#
.NET修仙日记4 小时前
SQL Server实战指南:从基础CRUD到高并发处理的完整面试题库
面试·职场和发展·c#·.net·sql server·.net全栈经典面试题库
武文斌776 小时前
项目学习总结:CAN总线、摄像头、STM32概述
linux·arm开发·stm32·单片机·嵌入式硬件·学习·c#
sali-tec7 小时前
C# 基于halcon的视觉工作流-章46-不匀面划痕
人工智能·算法·计算机视觉·c#
数字化顾问7 小时前
从 DAG 到 Shuffle:掌握 Spark RDD 宽窄依赖的调优密码
c#·linq