1、WebApiTestClient介绍
一、WebApiTestClient组件做用主要有如下几个：css
（1）、将WebApi的接口放到了浏览器里面，以可视化的方式展示出来，好比咱们经过http://localhost:8080/Help这个地址就能在浏览器里面看到这个服务里面全部的API接口以及接口的详细说明，省去了咱们手写接口文档的麻烦。html
（2）、可以详细查看API的类说明、方法说明、参数说明、返回值说明。只须要咱们在定义方法时候加上 /// <summary> 这种详细注释便可，组件自动读取注释里面的内容展示在界面上面。git
（3）、能够修改http请求头文件Head和请求体Body里面的参数，指定发送http请求的特性，好比指定咱们最多见的contentType指示参数的类型。github
（4）、组件拥有测试接口的功能，用过Soup UI的朋友应该知道，经过Soup UI可以方便测试WebService参数以及返回值。咱们的WebApiTestClient也能够实现相似的功能，直接经过页面上的测试按钮，就能测试接口。json
二、WebApiTestClient是一个开源组件。开源地址：https://github.com/yaohuang/WebApiTestClient浏览器
2、WebApiTestClient展现
第一印象：接口列表。 
app
点击某一个接口查看接口详细。例如本文查看Get请求的无参方法，右下角有按钮能够测试接口。ide
点击“Test API”按钮工具
点击Send发送请求post
第二个有参数的接口
手动输入参数，获得返回结果
若是参数的类型是对象，能够直接解析class定义上面的 /// <summary> 标注，显示以下
因为是post请求，若是须要执行参数长度和类型，能够经过content-length和content-type来指定。而且具体的参数能够指定不一样格式显示，好比下图的application/json和application/xml
获得返回值
3、WebApiTestClient使用
一、如何引入组件
首先，咱们须要定义一个API项目
而后经过Nuget引入组件，以下图。记住选下图中的第三个。
引入成功后，将向项目里面添加一些主要文件：
- Scripts\WebApiTestClient.js
- Areas\HelpPage\TestClient.css
- Areas\HelpPage\Views\Help\DisplayTemplates\TestClientDialogs.cshtml
- Areas\HelpPage\Views\Help\DisplayTemplates\TestClientReferences.cshtml
二、如何使用组件
一、修改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;
}
<link type="text/css" href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" />
<div id="body" class="help-page">
<section class="featured">
<div class="content-wrapper">
<p>
@Html.ActionLink("Help Page Home", "Index")
</p>
</div>
</section>
<section class="content-wrapper main-content clear-fix">
@Html.DisplayForModel()
</section>
</div>
@Html.DisplayForModel("TestClientDialogs")
@section Scripts{
<link href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" />
@Html.DisplayForModel("TestClientReferences")
}
二、配置读取注释的xml路径
其实，经过上面的步骤，咱们的项目已经能够跑起来了，也能够调用接口测试。可是，还不能读取 /// <summary> 注释里面的东西。须要作以下配置才行。
（1）配置生成xml的路径。咱们在项目上面点右键→属性→生成标签页配置xml的路径
（2）在xml的读取路径：在下图的HelpPageConfig.cs里面配置一句话，指定xml的读取路径。
这句代码以下：
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/WebApiTestClient.XML")));
三、测试接口
/// <summary>
/// 测试API Test Client
/// </summary>
public class TestChargingDataController : ApiController
{
/// <summary>
/// 获得全部数据
/// </summary>
/// <returns>返回数据</returns>
[HttpGet]
public string GetAllChargingData()
{
return "ChargingData";
}
/// <summary>
/// 获得当前Id的全部数据
/// </summary>
/// <param name="id">参数Id</param>
/// <returns>返回数据</returns>
[HttpGet]
public string GetAllChargingData(string id)
{
return "ChargingData" + id ;
}
/// <summary>
/// Post提交
/// </summary>
/// <param name="oData">对象</param>
/// <returns>提交是否成功</returns>
[HttpPost]
public bool Post(TB_CHARGING oData)
{
return true;
}
/// <summary>
/// Put请求
/// </summary>
/// <param name="oData">对象</param>
/// <returns>提交是否成功</returns>
[HttpPut]
public bool Put(TB_CHARGING oData)
{
return true;
}
/// <summary>
/// delete操做
/// </summary>
/// <param name="id">对象id</param>
/// <returns>操做是否成功</returns>
[HttpDelete]
public bool Delete(string id)
{
return true;
}
}
/// <summary>
/// 充电对象实体
/// </summary>
public class TB_CHARGING
{
/// <summary>
/// 主键Id
/// </summary>
public string ID { get; set; }
/// <summary>
/// 充电设备名称
/// </summary>
public string NAME { get; set; }
/// <summary>
/// 充电设备描述
/// </summary>
public string DES { get; set; }
/// <summary>
/// 建立时间
/// </summary>
public DateTime CREATETIME { get; set; }
}
至此，组件就搭完了，剩下的就是运行了。咱们在url里面敲地址http://localhost:8080/Help/Index或者http://localhost:8080/Help就能获得上述效果。还不赶忙试试~~