一. 支持注释
1.首先进行项目的创建,我这边以.net 7 为例来进行解说,因为.net 7中没有startup.cs文件,startup.cs文件已与program.cs文件进行了合并,我们来配置program.cs文件来让Swagger文档支持控制器的注释以及操作方法的注释
进入program.cs文件 里面会显示此配置,我们将此配置进行更换为下面的代码配置
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
#region Swagger的配置
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(option=>
{
// xml文档绝对路径--读取根据控制器api生成的Xml的文件
var file = Path.Combine(AppContext.BaseDirectory,"ReadingPlatForm.xml");
// true : 显示控制器层注释
option.IncludeXmlComments(file, true);
// 对option的名称进行排序,如果有多个,就可以看见效果了。
option.OrderActionsBy(o => o.RelativePath);
});
#endregion
配置完成后,右键项目文件夹=》属性,勾选生成包含API文档的文件,勾选完毕后重新生成解决方案,即可在项目的DeBug目录下 可以查看到 ReadingPlatForm.xml这个配置文件(这个文件的名称 最好以项目名称进行命名),此时启动项目,则可以看到控制器和操作方法带有自己书写的注释