本文共 1960 字，大约阅读时间需要 6 分钟。

WebApiTestClient 安装与使用说明

1. WebApiTestClient 简介

WebApiTestClient 是一个开源组件，能够直观展示 Web API 接口的详细信息，并支持接口测试。以下是其主要功能：

• 可视化接口展示：通过浏览器访问指定地址（如 http://localhost:8080/Help），即可看到服务中的所有 API 接口及其详细说明。
• 注释解读：自动读取接口注释，展现接口、类、参数及返回值的说明。
• 请求配置：支持修改 HTTP 请求头和请求体参数，灵活设置接口调用属性。
• 动态测试：提供测试功能，可通过界面按钮直接调用接口。

2. 安装步骤

为了使用 WebApiTestClient，需先将其加入项目：

安装完成后，项目会自动生成相关文件，分别位于：

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

3. 配置注释读取

为了实现注释内容的展示，需做以下配置：

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

完成以上配置后，注释内容将自动读取并展示。

4. 使用示例

假设我们有如下 API 控制器：

public class TestChargingDataController : ApiController
{
    [HttpGet]
    public string GetAllChargingData()
    {
        return "ChargingData";
    }
    [HttpGet]
    public string GetAllChargingData(string id)
    {
        return $"ChargingData{id}";
    }
    [HttpPost]
    public bool Post(TB_CHARGING oData)
    {
        return true;
    }
    [HttpPut]
    public bool Put(TB_CHARGING oData)
    {
        return true;
    }
    [HttpDelete]
    public bool Delete(string id)
    {
        return true;
    }
}
public class TB_CHARGING
{
    public string ID { get; set; }
    public string NAME { get; set; }
    public string DES { get; set; }
    public DateTime CREATETIME { get; set; }
}

在 Api.cshtml 中添加以下包含：

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

访问 http://localhost:8080/Help，即可查看完整的接口文档。通过输入参数或确认请求方式，测试接口即可。

克制推荐：WebApiTestClient 可作为个性化帮助文档使用，简化展示和测试流程。

转载地址：http://ybmkk.baihongyu.com/