博客
关于我
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中的约束
    查看>>
    MySQL中的表是什么?
    查看>>
    mysql中穿件函数时候delimiter的用法
    查看>>
    Mysql中索引的分类、增删改查与存储引擎对应关系
    查看>>
    Mysql中索引的最左前缀原则图文剖析(全)
    查看>>
    MySql中给视图添加注释怎么添加_默认不支持_可以这样取巧---MySql工作笔记002
    查看>>
    Mysql中获取所有表名以及表名带时间字符串使用BetweenAnd筛选区间范围
    查看>>
    Mysql中视图的使用以及常见运算符的使用示例和优先级
    查看>>
    Mysql中触发器的使用示例
    查看>>
    Mysql中设置只允许指定ip能连接访问(可视化工具的方式)
    查看>>
    mysql中还有窗口函数?这是什么东西?
    查看>>
    mysql中间件
    查看>>
    MYSQL中频繁的乱码问题终极解决
    查看>>
    MySQL为Null会导致5个问题,个个致命!
    查看>>
    MySQL为什么不建议使用delete删除数据?
    查看>>
    MySQL主从、环境搭建、主从配制
    查看>>
    Mysql主从不同步
    查看>>
    mysql主从同步及清除信息
    查看>>
    MySQL主从同步相关-主从多久的延迟?
    查看>>
    mysql主从同步配置方法和原理
    查看>>