c# webAPI项目 添加 Swagger 调试

c# webAPI项目 添加 Swagger 调试

1.打开工具–>NuGet包管理器–>管理解决方案的NuGet程序包
2.搜索Swashbuckle.AspNeT，安装到webAPI项目中
3.Startup.cs中配置中间件，
1）在public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
后增加
//添加swagger
services.AddSwaggerGen(c =>
{
c.SwaggerDoc(“v0”, new OpenApiInfo { Title = “测试”, Version = “1.0.0.0” });
//获取xml文件名
var xmlFile = $“{Assembly.GetExecutingAssembly().GetName().Name}.xml”;
//获取xml文件路径
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
//是否显示注释
c.IncludeXmlComments(xmlPath, true);
});

2） 在app.UseRouting();后增加
app.UseSwagger();
app.UseSwaggerUI(c=>
{
c.SwaggerEndpoint(“/swagger/v0/swagger.json”, “测试”);
}
);

4.解决方案中的项目上,右键–>属性–>生成–>输出–>将xml文档文件，打钩，让有xml文件的位置，

5. 进行分组，在 控制器的文件中 TestController.cs中，类定义的前面
   输入
   [ApiExplorerSettings(GroupName = “v0”)]

6. 使用：运行项目
   浏览器输入 地址 https://local:2000/swagger/index.html