1.新建项目-选择Asp.Net Web应用程序
2.接着选择Web Api,点击右下角创建
3.右键点击所建项目,选中“管理NuGet程序包”
4.搜索"Swashbuckle",选中并点击"安装"
5.安装完成,App Start文件夹里会多一个SwaggerConfig.cs文件
6.打开SwaggerConfig.cs,拉到最底下增加以下代码,并找到“//c.IncludeXmlComments(GetXmlCommentsPath();"去掉其注释,即去掉//,并在项目属性中,勾选XML文档文件,即可在运行时看到自己对控制器的备注,StudyWebApi跟自己项目名一致即可
private static string GetXmlCommentsPath()
{
return $"{System.AppDomain.CurrentDomain.BaseDirectory}/bin/StudyWebApi.xml";
}
7.新建控制器,并创建接口名以及描述,去掉Web.MVC引用,换成引用Web.Http,将继承类由Controller换成ApiController,然后点击IIS Express
8.跳转浏览器后,网址后加上/swagger回车即可
9.其他配置
1)、路由地址改动,找到WebApiConfig.cs文件,将api/{controller}/{id}改成api/{controller}/{action}/{id},要不然参数相同的接口名无法带出,action即接口名
2)、在Layout.cshtml添加行
即可在启动主页添加Swagger标签,点击即可调整Swagger页面
版权归原作者 静默归忆 所有, 如有侵权,请联系我们删除。