详解C# WebApi 接口测试工具：WebApiTestClient

由于是post请求，如果需要执行参数长度和类型，可以通过content-length和content-type来指定。并且具体的参数可以指定不同格式显示，比如下图的application/json和application/xml

得到返回值

三、WebApiTestClient使用

1、如何引入组件

首先，我们需要定义一个API项目

然后通过Nuget引入组件，如下图。记住选下图中的第三个。

引入成功后，将向项目里面添加一些主要文件：

Scripts\WebApiTestClient.js Areas\HelpPage\TestClient.css Areas\HelpPage\Views\Help\DisplayTemplates\TestClientDialogs.cshtml Areas\HelpPage\Views\Help\DisplayTemplates\TestClientReferences.cshtml

2、如何使用组件

1、修改Api.cshtml文件

通过上述步骤，就能将组件WebAPITestClient引入进来。下面我们只需要做一件事：打开文件 (根据 Areas\HelpPage\Views\Help) Api.cshtml 并添加以下内容:

@Html.DisplayForModel("TestClientDialogs") @Html.DisplayForModel("TestClientReferences")

添加后Api.cshtml文件的代码如下

@using System.Web.Http @using WebApiTestClient.Areas.HelpPage.Models @model HelpPageApiModel @{ var description = Model.ApiDescription; ViewBag.Title = description.HttpMethod.Method + " " + description.RelativePath; }

2、配置读取注释的xml路径

其实，通过上面的步骤，我们的项目已经可以跑起来了，也可以调用接口测试。但是，还不能读取///

注释里面的东西。需要做如下配置才行。

（1）配置生成xml的路径。我们在项目上面点右键→属性→生成标签页配置xml的路径

（2）在xml的读取路径：在下图的HelpPageConfig.cs里面配置一句话，指定xml的读取路径。

这句代码如下：

复制代码 代码如下:

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/WebApiTestClient.XML")));

3、测试接口

///

/// 测试API Test Client ///

public class TestChargingDataController : ApiController { ///

/// 得到所有数据 ///

/// 返回数据 [HttpGet] public string GetAllChargingData() { return "ChargingData"; } ///

/// 得到当前Id的所有数据 ///

/// 参数Id /// 返回数据 [HttpGet] public string GetAllChargingData(string id) { return "ChargingData" + id ; } ///

/// Post提交 ///

/// 对象 /// 提交是否成功 [HttpPost] public bool Post(TB_CHARGING oData) { return true; } ///

/// Put请求 ///

/// 对象 /// 提交是否成功 [HttpPut] public bool Put(TB_CHARGING oData) { return true; } ///

/// delete操作 ///

/// 对象id /// 操作是否成功 [HttpDelete] public bool Delete(string id) { return true; } } ///

/// 充电对象实体 ///

public class TB_CHARGING { ///

/// 主键Id ///

public string ID { get; set; } ///

/// 充电设备名称 ///

public string NAME { get; set; } ///

/// 充电设备描述 ///

public string DES { get; set; } ///

/// 创建时间 ///

public DateTime CREATETIME { get; set; } }

至此，组件就搭完了，剩下的就是运行了。我们在url里面敲地址http://localhost:8080/Help/Index或者http://localhost:8080/Help就能得到上述效果。还不赶紧试试~~

四、总结

上面简单总结了下WebApiTestClient的使用，如果你的WebApi也是一个单独的服务，可以整起来当帮助文档用，省得你自己写。哈哈，不要谢我，请叫我红领巾。欢迎推荐。Demo下载 密码: u13g

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。