.Net WebApi接口调试之Swagger集成详解
2016-07-19 09:07
295 查看
引:以前没有写博的习惯,后来 在网上看到有些问题被一些刚入行的同学问来问去没有完整的教程供他们参考,决定以后也把自己的一些经验分享到网上,希望能帮助其他同学的同时,更多的与大家交流!有不对的地方还请多多指点,互相学习,共同进步。
本文详细的介绍了.net从一个新的项目中创建api后集成swagger调试接口的流程!
1、首先我们创建一个MVC项目(VS2012):
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/cd03b4b48134917aed0036458a02614f)
2、然后在项目中的Controllers文件夹中添加API接口文件(WebApi):
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/38c287ad7182fdf56b17681bf582769e)
创建之后,接口中随便写一个获取信息的方法:
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/b5a37c4239f65a28a203eccc8b9bc698)
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/d05f08975a8199fa7bc7c4369e7bd982)
3、集成swagger,通过nuget管理平台添加(右键网站项目-->管理NuGet程序包):
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/77b11cd3d1a1d68f75e93d0d4675d7ca)
安装之后生成的swagger配置文件:
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/6ccf9ff1c541d6706dd1eb88690a1cab)
4、安装之后还没法正常访问swagger,需要配置网站属性:
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/2454b16aedf8718553445e31290f4657)
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/24979509f2c9ac90f93fb31dab247f02)
protected static string GetXmlCommentsPath()
{
var re = System.String.Format(@"{0}\bin\APIExample.XML", System.AppDomain.CurrentDomain.BaseDirectory);
return re;
}
XML名称必须与网站生成的XMl名称一致。
5、大功告成:
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/b867eac2738fd86a9b4dba643efc5e23)
没有默认读取到自己接口文件的,请去SwaggerNet.cs文件中配置路由地址:
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/7dd9d1a0ef8a45beb7c72cd109d3c209)
补充,如果想在swagger界面显示自己的方法名,在方法名前加Route指令试试,由于我目前的web.http.dll库版本有点低,还不支持,升级后再试,不过小伙伴可以先试试。如图:
![](https://oscdn.geek-share.com/Uploads/Images/Content/201911/15/75d6f59f000f65e809741466109695ca)
完!
有什么问题欢迎交流:Q、397874468
本文详细的介绍了.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
相关文章推荐
- 分享微信开发Html5轻游戏中的几个坑
- Android Manifest 用法
- 什么是 GraphQL?
- Spark RDD API详解(一) Map和Reduce
- Spring Boot 开发微服务
- 如何在 Linux/Windows/MacOS 上使用 .NET 进行开发
- lwn拾遗:[sn3218 led drivers]-api解释-1
- 页面元素查找之Selectors API
- 如何在 Linux 中安装微软的 .NET Core SDK
- 一个小型js框架myJSFrame附API使用帮助
- C#.NET获取拨号连接的宽带连接方法
- C#.Net ArrayList的使用方法
- 详细分析交换机、路由器、集线器的区别和联系
- PowerShell打开或关闭光驱
- 批处理的api WMIC学习体会有感第1/2页
- 批处理 API实现文件下载的代码第1/2页
- Lua教程(十七):C API简介
- 强制删除工具 xdelbox xdelbox1.5正式版下载
- 揪出交换机端口背后“凶手”导致网速太慢
- 电脑重启后突然检测不到硬盘的原因分析与解决办法