.NET Core2.2 WebApi项目 配置使用Swagger 5.0+

工具：vs 2017  环境：.net core 2.2  Swagger 5.0+

1、新建一个.net core的webapi的项目

 

 

 

 

 

 

 

运行结果：

 

 

 2、Nuget 安装 Swashbuckle.AspNetCore 5.6.3  和 Swashbuckle.AspNetCore.SwaggerUI 5.6.3

 

 

 3、配置swagger中间件

 

 

 

 4、运行结果

 

 项目自动生成的控制器和方法

 

小技巧：

1、设置运行时默认打开swagger。选中项目，右键-》属性-》调试

 

2、给每个API接口设置注释，方便阅读

 

 

 

 

 

 

 

 

 

遇到的坑：

1、配置使用注释的时候，出现找不到.xml文件

 

 解决办法：

勾选XML文档文件

 

 

 

 2、Swagger报错

 

 解决办法：

检查一下控制器里的每个方法是否都加上请求方式，如：[HttpGet]、[HttpPost]等

 

附上相关代码：

Startup.ConfigureServices

services.AddSwaggerGen(options =>
{
　　options.SwaggerDoc("v1", new OpenApiInfo
　　{
　　　　Title = ".Net Core中间件API文档", //标题
　　　　Version = "v1", //版本
　　　　Description = "接口描述", //描述
　　　　Contact = new OpenApiContact() //联系方式
　　　　{
　　　　　　Name = "wangxiaorang", //名称
　　　　　　Email = "12121@qq.com", //邮箱
　　　　　　Url = new Uri("https://www.cnblogs.com/wangxiaorang") //页面地址
　　　　}
});

　　// 为 Swagger 设置xml文档注释路径
　　var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
　　var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
　　options.IncludeXmlComments(xmlPath);
});

 

Startup.Configure

//使用swagger服务
app.UseSwagger();
app.UseSwaggerUI(options =>
{
　　options.ShowExtensions();
　　options.SwaggerEndpoint("/swagger/v1/swagger.json", "版本1");
});