C# WebApi 接口测试工具：WebApiTestClient 实战指南

C# WebApi 接口测试工具：WebApiTestClient 实战指南

在开发 ASP.NET WebApi 时，自测或提供给第三方调试是常见需求。相比 Postman、Fiddler 等外部工具，WebApiTestClient 的优势在于轻量级且可直接集成在项目内部，无需额外安装注册，通过浏览器即可访问使用。

核心特性

• 零依赖安装：作为 NuGet 包引入，直接嵌入项目，浏览器打开即可用。
• 灵活配置：支持自定义 HTTP 方法（GET/POST/PUT/DELETE）、请求头及请求体。
• 实时反馈：即时展示响应状态码、响应头及响应体，便于快速定位问题。
• 前后端协同：前端开发人员可直接调用后端接口验证数据交互，减少联调成本。

集成与配置步骤

1. 引入组件

在 Visual Studio 中打开 WebApi 项目，通过 NuGet 管理器搜索并安装 WebApiTestClient。安装成功后，项目结构会自动增加以下文件：

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

2. 修改视图文件

为了启用测试界面，需要修改帮助页面的视图文件。找到 Areas\HelpPage\Views\Help\Api.cshtml，在文件末尾添加以下代码以加载测试对话框和引用模板：

@using System.Web.Http 
@using WebApiDemo.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> 
<section> 
<div> <p> @Html.ActionLink("Help Page Home", "Index") </p> </div> </section> 
<section> @Html.DisplayForModel() </section> </div> 
@Html.DisplayForModel("TestClientDialogs") 
@section Scripts{ <link href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" /> @Html.DisplayForModel("TestClientReferences") }

3. 配置 XML 文档路径

为了让测试页面能读取代码中的注释信息（如 /// <summary>），需要生成并配置 XML 文档路径。

首先，在项目属性中开启 XML 文档生成：右键项目 → 属性 → 生成 → 勾选'XML 文档文件'。

接着，在 HelpPageConfig.cs 中指定读取路径。找到 Register 方法，取消注释并修改如下配置：

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

完整的 HelpPageConfig.cs 示例如下：

// Uncomment the following to provide samples for PageResult<T>. Must also add the Microsoft.AspNet.WebApi.OData // package to your project. ////#define Handle_PageResultOfT using System; using System.Collections; using System.Collections.Generic; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using System.Linq; using System.Net.Http.Headers; using System.Reflection; using System.Web; using System.Web.Http; #if Handle_PageResultOfT using System.Web.Http.OData; #endif namespace WebApiDemo.Areas.HelpPage { /// <summary> /// Use this class to customize the Help Page. /// For example you can set a custom <see cref="System.Web.Http.Description.IDocumentationProvider"/> to supply the documentation /// or you can provide the samples for the requests/responses. /// </summary> public static class HelpPageConfig { [SuppressMessage("Microsoft.Globalization", "CA1303:Do not pass literals as localized parameters", MessageId = "WebApiDemo.Areas.HelpPage.TextSample.#ctor(System.String)", Justification = "End users may choose to merge this string with existing localized resources.")] [SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "bsonspec", Justification = "Part of a URI.")] public static void Register(HttpConfiguration config) { //// Uncomment the following to use the documentation from XML documentation file. //config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml"))); //// Uncomment the following to use "sample string" as the sample for all actions that have string as the body parameter or return type. //// Also, the string arrays will be used for IEnumerable<string>. The sample objects will be serialized into different media type //// formats by the available formatters. //config.SetSampleObjects(new Dictionary<Type, object> //{ // {typeof(string), "sample string"}, // {typeof(IEnumerable<string>), new string[]{"sample 1", "sample 2"}} //}); // Extend the following to provide factories for types not handled automatically (those lacking parameterless // constructors) or for which you prefer to use non-default property values. Line below provides a fallback // since automatic handling will fail and GeneratePageResult handles only a single type. #if Handle_PageResultOfT config.GetHelpPageSampleGenerator().SampleObjectFactories.Add(GeneratePageResult); #endif // Extend the following to use a preset object directly as the sample for all actions that support a media // type, regardless of the body parameter or return type. The lines below avoid display of binary content. // The BsonMediaTypeFormatter (if available) is not used to serialize the TextSample object. config.SetSampleForMediaType( new TextSample("Binary JSON content. See http://bsonspec.org for details."), new MediaTypeHeaderValue("application/bson")); //// Uncomment the following to use "[0]=foo&[1]=bar" directly as the sample for all actions that support form URL encoded format //// and have IEnumerable<string> as the body parameter or return type. //config.SetSampleForType("[0]=foo&[1]=bar", new MediaTypeHeaderValue("application/x-www-form-urlencoded"), typeof(IEnumerable<string>)); //// Uncomment the following to use "1234" directly as the request sample for media type "text/plain" on the controller named "Values" //// and action named "Put". //config.SetSampleRequest("1234", new MediaTypeHeaderValue("text/plain"), "Values", "Put"); //// Uncomment the following to use the image on "../images/aspNetHome.png" directly as the response sample for media type "image/png" //// on the controller named "Values" and action named "Get" with parameter "id". //config.SetResponse(new ImageSample("../images/aspNetHome.png"), new MediaTypeHeaderValue("image/png"), "Values", "Get", "id"); //// Uncomment the following to correct the sample request when the action expects an HttpRequestMessage with ObjectContent<string>. //// The sample will be generated as if the controller named "Values" and action named "Get" were having string as the body parameter. //config.SetActualRequestType(typeof(string), "Values", "Get"); //// Uncomment the following to correct the sample response when the action returns an HttpResponseMessage with ObjectContent<string>. //// The sample will be generated as if the controller named "Values" and action named "Post" were returning a string. //config.SetActualResponseType(typeof(string), "Values", "Post"); config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/WebApiDemo.xml"))); } #if Handle_PageResultOfT private static object GeneratePageResult(HelpPageSampleGenerator sampleGenerator, Type type) { if (type.IsGenericType) { Type openGenericType = type.GetGenericTypeDefinition(); if (openGenericType == typeof(PageResult<>)) { // Get the T in PageResult<T> Type[] typeParameters = type.GetGenericArguments(); Debug.Assert(typeParameters.Length == 1); // Create an enumeration to pass as the first parameter to the PageResult<T> constuctor Type itemsType = typeof(List<>).MakeGenericType(typeParameters); object items = sampleGenerator.GetSampleObject(itemsType); // Fill in the other information needed to invoke the PageResult<T> constuctor Type[] parameterTypes = new Type[] { itemsType, typeof(Uri), typeof(long?), }; object[] parameters = new object[] { items, null, (long)ObjectGenerator.DefaultCollectionSize, }; // Call PageResult(IEnumerable<T> items, Uri nextPageLink, long? count) constructor ConstructorInfo constructor = type.GetConstructor(parameterTypes); return constructor.Invoke(parameters); } } return null; } #endif } }