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

});

效果

相关推荐
de之梦-御风20 分钟前
【Winform】OwnerDraw(自绘) 的用法
.net
Jp7gnUWcI1 小时前
基于.NET操作Excel COM组件生成数据透视报表
.net·excel
山檐雾2 小时前
OctreeNode
unity·c#·八叉树
tHeya06II2 小时前
.NET AI 核心构建块:重塑智能应用开发的架构范式与生态
人工智能·架构·.net
wd5i8kA8i3 小时前
.NET 10 New feature 新增功能介绍-Minimal APIs增强
.net
UAq6wn76j5 小时前
.NET源码生成器使用SyntaxTree生成代码及简化语法
java·开发语言·.net
QfC92C02p5 小时前
C# 中的 Span 和内存:.NET 中的高性能内存处理
java·c#·.net
Yuri X-20216 小时前
VS2022实战测试题——2
程序人生·c#·个人开发·visual studio
刚子编程6 小时前
.NET 8 性能优化实战:让你的应用起飞
性能优化·.net
公子小六7 小时前
基于.NET的Windows窗体编程之WinForms布局简介
windows·microsoft·c#·.net