NetCore 配置Swagger的详细代码_实用技巧_

install-package Swashbuckle.AspNetCore -project XXX -version 6.4.0

/// 
 /// Swagger 静态类 /// 
 public static class SwaggerExtend { /// 
 /// 添加服务: swagger /// 
 ///  ///  public static void AddCustSwagger(this IServiceCollection services) { var version = "V1.0"; var apiName = "XXX系统"; services.AddSwaggerGen(options => { options.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); options.SwaggerDoc("system_v1", new OpenApiInfo { Version = version, Title = $"{apiName} API", Description = $"{apiName} {version} 接口服务" }); // 获取应用程序所在目录 var basePath = Path.GetDirectoryName(typeof(SwaggerExtend).Assembly.Location); var xmlPath = Path.Combine(basePath, "ProjectName.xml"); // swagger界面默认只显示 方法&字段 注释，不显示 控制器注释 // 第二个参数为true， 则是controller的注释 //options.IncludeXmlComments(xmlPath); options.IncludeXmlComments(xmlPath, true); }); } /// 
 /// 添加中间件: swagger /// 
 ///  public static void UseCustSwagger(this IApplicationBuilder app) { app.UseSwagger(); app.UseSwaggerUI(options => { options.SwaggerEndpoint("/swagger/system_v1/swagger.json", "系统API"); // 默认路径为：/swagger/index.html // 路由前缀 - 设置为空，可直接跳转到swagger页面：/index.html // api测试可设置为空，部署时容易与前端路由冲突 options.RoutePrefix = string.Empty; }); } }

public void ConfigureServices(IServiceCollection services) { services.AddCustSwagger(); } public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { app.UseCustSwagger(); }