ARTICLE DETAIL

建站实战干货

来自一线的建站与推广经验沉淀,每一条都经过真实交付验证。

.NET Core WebAPI中封装Swagger配置

2026/8/4 11:40:01 拓冰建站 浏览量
.NET Core WebAPI中封装Swagger配置

一、创建相关文件

  1. 创建一个Utility/SwaggerExt文件夹,添加一个类
    在这里插入图片描述

二、在Program中找到Swagger相关配置信息

在这里插入图片描述

三、添加方法,在Program中调用

  1. 在SwaggerExt类中添加方法,将相关配置添写入

在这里插入图片描述

/// <summary>
/// swagger配置
/// </summary>
/// <param name="builder"></param>
public static void AddSwaggerExt(this WebApplicationBuilder builder )
{builder.Services.AddSwaggerGen();// 添加swagger注释builder.Services.AddSwaggerGen(x =>{x.SwaggerDoc("v1", new OpenApiInfo { Title = "Swagger标题", Version = "第一版", Description = ".NET Core WebAPI中使用swagger版本控制,添加注释" });var curr = AppContext.BaseDirectory;x.IncludeXmlComments(curr + "/WebApplication1.xml", true);});
}
/// <summary>
/// 使用Swagger
/// </summary>
/// <param name="app"></param>
public static void UseSwaggerExt(this WebApplication app)
{app.UseSwagger();app.UseSwaggerUI();
}
  1. 调用封装的方法

在这里插入图片描述

 // 调用封装的Swagger配置
//SwaggerExt.AddSwaggerExt(builder);
builder.AddSwaggerExt();if (app.Environment.IsDevelopment())
{app.UseSwaggerExt();
}