Swagger 接口文档管理

Swagger是我们的好朋友，让后端不用再写文档(当然文档该写的还得写)

但是更方便我们对自己接口的测试，推荐使用Swagger 进行接口文档管理

这里简单介绍比较常用的的点，
一定要提官方文档
https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-6.0&tabs=visual-studio
文档比我写的讲的详细

1.Swagger 注释

我们要把打开Xml文件生成
首先打开你项目的.csproj文件
打开方式 右键项目 -> 编辑项目文件

我们希望在每个方法后面添加介绍，以便于我们测试和前端的阅读

我们要打开XML文档文件生成

首先打开你项目的.csproj文件

打开方式 右键项目 -> 编辑项目文件

	<PropertyGroup>
	//加上底下这行代码
	<GenerateDocumentationFile>True</GenerateDocumentationFile>
	</PropertyGroup>

或者

右键项目 -> 属性 -> 生成 -> 输出 -> 文档文件 -> 勾选上生成包含API文档的文件

然后Progarm.cs 添加如下代码

	builder.Services.AddSwaggerGen(options => {
	//注释
	var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
	//第二个参数为是否显示控制器注释,我们选择true
	options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename),true);
	});

转载自：https://bxshare.top/index.php/archives/12/