LL-TJL

导航

< 2025年3月 >
23 24 25 26 27 28 1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31 1 2 3 4 5
统计
 

1.安装Nuget包:Swashbuckle.AspNetCore

2.使用Swagger中间件

builder.Services.AddEndpointsApiExplorer();

builder.Services.AddSwaggerGen(option =>
{

  

  //要启用swagger版本控制要在api控制器或者方法上添加特性[ApiExplorerSettings(GroupName = "版本号")] 
  typeof(ApiVersions).GetEnumNames().ToList().ForEach(version =>
  {
    option.SwaggerDoc(version, new OpenApiInfo()
    {
      Title = $"{version}:Api文档",
      Version = version,
      Description = $"{version}"
    });
  });

  // xml文档绝对路径,你的api.xml文件在项目属性=》生成=》输出=》文档文件,xml文件路径可选可不选

  var file = Path.Combine(AppContext.BaseDirectory, "你的api.xml");

  // true : 显示控制器层注释

  option.IncludeXmlComments(file, true);

  // 对action的名称进行排序,如果有多个,就可以看见效果了。

  option.OrderActionsBy(o => o.RelativePath);

})

app.UseSwagger();

//配置swagger.json
app.UseSwaggerUI(option =>
{
  foreach (string version in typeof(ApiVersions).GetEnumNames())
  {
    option.SwaggerEndpoint($"/swagger/{version}/swagger.json", $"{version}");
  }
});

3.其中ApiVersions可以是枚举,可以是任何集合,只要能更好的操作就行了

 

posted on   妖怪得懒癌  阅读(159)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· 物流快递公司核心技术能力-地址解析分单基础技术分享
· .NET 10首个预览版发布:重大改进与新特性概览!
· 单线程的Redis速度为什么快?
· 展开说说关于C#中ORM框架的用法!
· Pantheons:用 TypeScript 打造主流大模型对话的一站式集成库
 
点击右上角即可分享
微信分享提示