Core3.0使用Swagger接口文档

步骤

1.引用Nuget

<PackageReference Include="Swashbuckle.AspNetCore" Version="6.1.4" />

2.Startup.cs配置

//ConfigureServices
//注册swagger服务,定义1个或者多个swagger文档
services.AddSwaggerGen(s =>
{
	//设置swagger文档相关信息
	s.SwaggerDoc("v1", new OpenApiInfo
	{
		Title = "Api文档",
		Description = "接口文档",
		Version = "v1.0"
	});

	//获取xml注释文件的目录
	var xmlFile = $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}.xml";
	var xmlPath = System.IO.Path.Combine(AppContext.BaseDirectory, xmlFile);
	// 启用xml注释
	s.IncludeXmlComments(xmlPath);
});

//Configure
//启用swagger中间件
app.UseSwagger();
//启用SwaggerUI中间件（htlm css js等），定义swagger json 入口
app.UseSwaggerUI(s =>
{
	s.SwaggerEndpoint("/swagger/v1/swagger.json", "NoteWebapi文档v1");
	//要在应用的根 (http://localhost:<port>/) 处提供 Swagger UI，请将 RoutePrefix 属性设置为空字符串：
	//s.RoutePrefix = string.Empty;
});

3.项目生成设置
生成-输出
配置输出路径和XML文档文件

4.忽略注释配置
生成-输出
取消显示警告 1701;1702;1591