1.创建asp.net core api 项目

在初始项目中默认已经集成了swaggerUI的界面
这里采用的是中间件的形式进行调用


UI界面如下

2.给swagger添加注释的操作,首先点击项目窗体项目呼出属性
![]()
勾选以下内容,编译是会在项目默认的bin目录产生一个xml文件

3.替换以下中间件代码
builder.Services.AddSwaggerGen(option =>
{
{ //xml文档的绝对路径
var file = Path.Combine(AppContext.BaseDirectory, "WebApplication2.xml");
//true显示 控制器注释
option.IncludeXmlComments(file,true);
//排序
option.OrderActionsBy (o=>o.RelativePath);
}
});
4.在接口前添加以下注释

///<summary>
///获取天气
///</summary>
///<returns></returns>
最后编译

本文介绍了如何在ASP.NETCore项目中启用SwaggerUI界面,通过中间件配置包含XML注释,并在API接口上添加详细的描述。步骤包括设置XML文件生成、替换中间件代码以及添加接口注解。
1360

被折叠的 条评论
为什么被折叠?



