你的位置:首页 > ASP.net教程

[ASP.net教程]Web API 自动生成帮助文档并使用Web API Test Client 测试


之前在项目中有用到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、在项目属性中进行如下设置,勾选

 

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

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/




俄罗斯旅游团报价优惠俄罗斯蜜月旅游行程参考俄罗斯特价旅游多少钱到俄罗斯游费用报价大全俄罗斯自助游攻略2015深圳春节去哪玩?深圳春节哪里有活动? 因爱而美 万宁石梅湾的浪漫栖息 2015世界之窗春节开放吗?深圳世界之窗春节门票多少钱? 2015深圳春节哪里有好玩的?深圳春节去哪里玩? 天下第一农庄如何?深圳天下第一农庄有什么好玩的? 深圳龙岗天下第一农庄票价?天下第一农庄优惠价? 冬季室内游火爆 探秘金石滩六大展馆 深圳天下第一农庄电话?天下第一农庄网站? 清远青龙峡漂流好玩吗?青龙峡漂流开车怎么走? 清远青龙峡漂流自带什么?青龙峡漂流需要带衣服吗? 青龙峡漂流自助游攻略?清远笔架山青龙峡漂流在哪里? 江油青龙峡漂流门票预约电话?青龙峡漂流多少钱? 云南西双版纳的最佳旅游时间是什么时候? 厦门有什么必尝特色美食啊? 丽江古城到束河古镇怎么走?有多远? 海南博鳌玉带滩有什么好吃的? LD033C273KAB2A Datasheet LD033C273KAB2A Datasheet 06032U180GAT2A Datasheet 06032U180GAT2A Datasheet 12061A4R7DAT2A Datasheet 12061A4R7DAT2A Datasheet 惠州旅游线路 惠州旅游线路 惠州旅游线路 惠州旅游 深圳出发 惠州旅游 深圳出发 惠州旅游 深圳出发 深圳 南昆山旅游 深圳 南昆山旅游 深圳 南昆山旅游