NetCore6 .0之配置Swagger接口文档终极教程

一、引用Nuget包

 Nuget包名称：NetGutSwashbuckle.AspNetCore   （5.0 以上版本都可以，目前笔者使用的是6.2.3版本）

二、配置Program.cs

1、配置服务->ConfigureServices（操作 builder.Services 项的操作，笔者一般会用#region 、#endregion框起，归为一类）

var ApiName = "NoName.Core";
builder.Services.AddSwaggerGen(s =>
{
    s.SwaggerDoc("V1", new OpenApiInfo
    {
        Version = "V1",
        Title = $"{ApiName} 接口文档——Netcore 6.0",
    });
    s.OrderActionsBy(o => o.RelativePath);
});

2、启用中间件->Configure（操作 builder.Build() 项的操作，笔者一般会用#region 、#endregion框起，归为一类）

var app = builder.Build();
app.UseSwagger();
app.UseSwaggerUI(s =>
{
    s.SwaggerEndpoint($"/swagger/V1/swagger.json", $"{ApiName} V1");

    s.RoutePrefix = "";//请求swagger路径
});

三、默认页设置为Swagger

修改launchSettings.json，注释掉launchUrl配置项，直接访问项目根路径就可以打开swagger

四、添加接口注释

如需显示下图的接口注释，需要进行以下配置：

1、右键项目名称=>属性=>生成=>“输出”=>“文档文件”,配置xml文件生成路径

2、Program.cs中增加配置，如图：

s.IncludeXmlComments("NoName.Core.xml", true);

文档参考：https://mp.weixin.qq.com/s/SHNNQoYF-t8i2j85E1oSYA【老张的哲学】

大家有兴趣的话，可以加QQ群：417151675 交流.NET技术。