.NET Core WebAPI中封装Swagger配置

一、创建相关文件

  1. 创建一个Utility/SwaggerExt文件夹,添加一个类

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

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

  1. 在SwaggerExt类中添加方法,将相关配置添写入
csharp 复制代码
/// <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);
    });
}
csharp 复制代码
/// <summary>
/// 使用Swagger
/// </summary>
/// <param name="app"></param>
public static void UseSwaggerExt(this WebApplication app)
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
  1. 调用封装的方法
csharp 复制代码
 // 调用封装的Swagger配置
//SwaggerExt.AddSwaggerExt(builder);
builder.AddSwaggerExt();

if (app.Environment.IsDevelopment())
{
    app.UseSwaggerExt();
}
相关推荐
crud6 小时前
Spring Boot 3 整合 Swagger:打造现代化 API 文档系统(附完整代码 + 高级配置 + 最佳实践)
java·spring boot·swagger
[email protected]1 天前
ASP.NET Core SignalR - 部分客户端消息发送
后端·asp.net·.netcore
bbsh20991 天前
WebFuture:Ubuntu 系统上在线安装.NET Core 8 的步骤
linux·ubuntu·.netcore·webfuture
MoFe12 天前
【.net core】【watercloud】树形组件combotree导入及调用
.netcore
MoFe12 天前
【.net core】.KMZ文件解压为.KML文件并解析为GEOJSON坐标数据集。附KML处理多线(LineString)闭环问题
.netcore
The Future is mine2 天前
在.NET Core控制器中获取AJAX传递的Body参数
c#·.netcore
无味无感3 天前
ASP.NET Core使用Quartz部署到IIS资源自动被回收解决方案
.netcore
MoFe13 天前
【.net core】天地图坐标转换为高德地图坐标(WGS84 坐标转 GCJ02 坐标)
java·前端·.netcore
步、步、为营4 天前
.NET Core接口IServiceProvider
.net·.netcore
冰茶_6 天前
建造者模式:优雅构建复杂对象
设计模式·微软·c#·.netcore·建造者模式·软件开发