.Net WebApi接口集成Swagger进行美化和调试教程

来源：互联网发布：常用网络协议端口号编辑：程序博客网时间：2024/06/05 02:58

引：以前没有写博的习惯，后来在网上看到有些问题被一些刚入行的同学问来问去没有完整的教程供他们参考，决定以后也把自己的一些经验分享到网上，希望能帮助其他同学的同时，更多的与大家交流！有不对的地方还请多多指点，互相学习，共同进步。

本文详细的介绍了.net从一个新的项目中创建api后集成swagger调试接口的流程！

1、首先我们创建一个MVC项目（VS2012）：

2、然后在项目中的Controllers文件夹中添加API接口文件（WebApi）：

创建之后，接口中随便写一个获取信息的方法：

3、集成swagger，通过nuget管理平台添加（右键网站项目-->管理NuGet程序包）：

安装之后生成的swagger配置文件：

4、安装之后还没法正常访问swagger，需要配置网站属性：

protected static string GetXmlCommentsPath()
{
var re = System.String.Format(@"{0}\bin\APIExample.XML", System.AppDomain.CurrentDomain.BaseDirectory);
return re;
}

XML名称必须与网站生成的XMl名称一致。

5、大功告成：

没有默认读取到自己接口文件的，请去SwaggerNet.cs文件中配置路由地址：

补充，如果想在swagger界面显示自己的方法名，在方法名前加Route指令试试，由于我目前的web.http.dll库版本有点低，还不支持，升级后再试，不过小伙伴可以先试试。如图：

完！

有什么问题欢迎交流：Q、397874468

0 0