.netcore3.1——应用文档组件Swagger

Swagger可以让我们更多的关注业务和代码实现，而不是天天改接口文档！！！   

（目前.net5中已经将该组件默认集成到webapi中，项目创建后作为首页展现）

1、Nuget引用：

 

2、ConfigureServices添加服务： 

//注册Swagger
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
    {
        Version = "v1",
        Title = "api文档",
        Description = "这是一个基于.net core的web API",
        Contact = new Microsoft.OpenApi.Models.OpenApiContact
        {
            Name = "这里是姓名",
            Email = "这里是邮箱",
            Url = new Uri("http://www.qufuyun.com")
        },
        License = new Microsoft.OpenApi.Models.OpenApiLicense
        {
            Name = "这里是许可证名字"
        }
    });
    // 为 Swagger JSON and UI设置xml文档注释路径-----
    // 获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径）
    var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
    var xmlPath = Path.Combine(basePath, "ProjectTracker.NetCore.WebUI.xml");
    c.IncludeXmlComments(xmlPath);
});

这里添加了引用xml文档，可以更友好的展现api，需要设置一下项目属性：

（添加取消警告代码是因为勾选了xml文档后若不显示添加说明会一直提示）

 

3、设置请求管道Configure：

// 启用Swagger中间件
app.UseSwagger();
// 配置SwaggerUI
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});

4、配置已经完成了，可以浏览效果：

 

Github（Swagger）：https://github.com/domaindrivendev/Swashbuckle.AspNetCore

微软文档也有简单案例：https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio