C# 在webapi项目中快捷方便配置Swagger(亲测好用)
1.安装swagger+swagger ui包
打开nuget界面,搜索swagger,并安装下面两个
安装完成之后,可以看到这些类与文件都是安装完成时swagger添加的
2.打开xml文档文件
右键项目属性—>生成—>勾选XML文档文件
3.SwaggerNet类中,注释类上面的两行,就会运行成功
4.这时,运行成功
5.添加注释
我们发现,安装完成后,写注释并没有在swagger页面上面增加,所以我们现在开开启注释
在SwaggerConfig类中,EnableSwagger的时候添加下面XML解析
c.IncludeXmlComments(GetXmlCommentsPath());
//添加XML解析方法
private static string GetXmlCommentsPath()
{
return string.Format(“{0}/bin/TestSwagger.XML”, System.AppDomain.CurrentDomain.BaseDirectory);
}
复制代码
注意修改相应的XML名字。
6.更改HomeController方法,增加 Response.Redirect(“/swagger/ui/index”);
完成!!