博客
关于我
C#进阶系列——WebApi 接口测试工具:WebApiTestClient
阅读量:791 次
发布时间:2019-03-24

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

WebApiTestClient 安装与使用说明

1. WebApiTestClient 简介

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

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

2. 安装步骤

为了使用 WebApiTestClient,需先将其加入项目:

  • 创建 API 项目:新建一个包含所有 API 的项目。
  • 运用 NuGet 包管理工具安装 WebApiTestClient:
    • 打开 Package Manager Window,输入 WebApiTestClient
    • 选择需要的版本(通常为 latest),然后点击 Install。
  • 安装完成后,项目会自动生成相关文件,分别位于:

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

    3. 配置注释读取

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

  • 指定生成 XML 的路径

    • 右键项目,选择Properties(属性)。
    • 在生成标签页中配置 XML 生成路径,通常为 ~/App_Data/WebApiTestClient.XML
  • 更新读取配置

    • 打开 HelpPageConfig.cs 文件,添加以下代码:
    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/

    你可能感兴趣的文章
    Mysql order by与limit混用陷阱
    查看>>
    Mysql order by与limit混用陷阱
    查看>>
    mysql order by多个字段排序
    查看>>
    MySQL Order By实现原理分析和Filesort优化
    查看>>
    mysql problems
    查看>>
    mysql replace first,MySQL中处理各种重复的一些方法
    查看>>
    MySQL replace函数替换字符串语句的用法(mysql字符串替换)
    查看>>
    mysql replace用法
    查看>>
    Mysql Row_Format 参数讲解
    查看>>
    mysql select, from ,join ,on ,where groupby,having ,order by limit的执行顺序和书写顺序
    查看>>
    MySQL Server 5.5安装记录
    查看>>
    mysql server has gone away
    查看>>
    mysql slave 停了_slave 停止。求解决方法
    查看>>
    MySQL SQL 优化指南:主键、ORDER BY、GROUP BY 和 UPDATE 优化详解
    查看>>
    MYSQL sql语句针对数据记录时间范围查询的效率对比
    查看>>
    mysql sum 没返回,如果没有找到任何值,我如何在MySQL中获得SUM函数以返回'0'?
    查看>>
    mysql Timestamp时间隔了8小时
    查看>>
    Mysql tinyint(1)与tinyint(4)的区别
    查看>>
    mysql union orderby 无效
    查看>>
    mysql v$session_Oracle 进程查看v$session
    查看>>