C# .net core(.net 6) 配置使用swagger

注：项目创建参考：https://blog.csdn.net/lwpoor123/article/details/127789441；

1、.net 6 web api 创建自带swagger NuGet包（Swashbuckle.AspNetCore）。

 

2、添加自定义信息

1、配置项目输出包含API文档的文件（不配置xml文档路径默认路径）

注：配置显示注释需要生成Swagger  xml文件

 

 

 

2、修改注册Swagger，添加自定义内容，显示接口注释

 

 

//注册Swagger
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(c =>
{
    #region 配置Swagger
    c.SwaggerDoc("V1.0", new OpenApiInfo
    {
        Title = "V1.0:接口文档",
        Description = $"API版本V1.0",
        Contact = new OpenApiContact
        {
            Name = "博客园燕钰达",
            Email = string.Empty,
            Url = new Uri("https://www.cnblogs.com/yyd-sun/")
        }
    });
    #endregion

    #region 配置展示注释
    {
        var path = Path.Combine(AppContext.BaseDirectory, "Demo02.xml");  // xml文档绝对路径
        c.IncludeXmlComments(path, true); // true : 显示控制器层注释
        c.OrderActionsBy(o => o.RelativePath); // 对action的名称进行排序，如果有多个，就可以看见效果了。

    }
    #endregion
});

3、修改使用Swagger部分

//测试环境启动
if (app.Environment.IsDevelopment())
{
    //使用Swagger
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint($"/swagger/V1.0/swagger.json", $"Demo01 V1.0");
    });
}

 

 

 注：版本信息部分保持一致