• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

asp.netwebAPI自动生成帮助文档并测试

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下。

先看一下生成的webapi文档。

1、下图展示的是生成帮助文档首页面,其中Values是controller,API下面的列表展示出请求的http方法(Get,POST等),请求的action,方法的描述。

2、点击红框内的链接,打开api方法的详情页面,如下图所示,

3、点击Test API打开如下页面

 

4、输入参数,点击Send按钮,打开如下页面,可以看到返回值。

 

设置的方法步骤如下:

开发环境VS2012 + MVC4 + WEB API

1、通过NuGet引用Web API Test Client

 

引用玩该DLL会生成如下文件:

这里面就是我们的帮助文档界面

 

 

2、在项目属性中进行如下设置,勾选XMl文档文件,并设置路径

3、在项目的App_Data文件夹下创建XmlDocument.xml

4、打开\Areas\HelpPage\App_Start\HelpPageConfig.cs文件,取消如下代码注释

 

运行项目,打开http://localhost:3619/Help,即可看到自动生成好的api文档,即该篇文章的一张图片

点击下载项目代码

参考:http://www.c-sharpcorner.com/UploadFile/2b481f/adding-the-test-api-in-the-Asp-Net-web-api-help-page/


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
ASP.NET常用的一些DOS命令发布时间:2022-07-10
下一篇:
七月所学(asp.net)发布时间:2022-07-10
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap