.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[] { }
                        }
                    });

});

效果

相关推荐
张人玉44 分钟前
技术开发文档:MES 系统与西门子 PLC 通信软件集成方案
https·c#·plc·mes系统·西门子s7
地球驾驶员4 小时前
NX二次开发C#----C#和C++的二次开发程序如何签名?
c#
用户4488466710605 小时前
.NET进阶——深入理解反射(2)细说Type类型与实例创建
.net
小码编匠5 小时前
C# 实现网络文件传输:打造稳定可靠的工业级工具
后端·c#·.net
MM_MS5 小时前
SQL Server数据库和Visual Studio (C#)联合编程
开发语言·数据库·sqlserver·c#·visual studio
c#上位机8 小时前
halcon计算区域骨架
图像处理·人工智能·计算机视觉·c#·halcon
曹牧9 小时前
C#:Dictionary类型数组
java·开发语言·c#
GeekyGuru10 小时前
C#:游戏开发的高效利器
开发语言·c#
关关长语11 小时前
基于NCrontab实现Covarel扩展秒级任务调度
c#·.net
足球中国11 小时前
什么情况下会发生跨域
c#·dataexcel·cfucion