C# WebApi 接口测试工具：WebApiTestClient 应用详解

2. 配置读取注释的 XML 路径

为了读取 /// <summary> 注释内容，需要进行如下配置。

（1）配置生成 XML 的路径。在项目上右键→属性→生成标签页配置 XML 的路径。

（2）在 HelpPageConfig.cs 里配置指定 XML 的读取路径。

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
    }
}

3. 测试接口

下面仅为简单接口示例：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
namespace WebApiDemo.Controllers {
    public class ValuesController : ApiController {
        // GET api/values
        public IEnumerable<string> Get() {
            return new string[] { "value1", "value2" };
        }
        // GET api/values/5
        public string Get(int id) {
            return "value";
        }
        // POST api/values
        public void Post([FromBody]string value) {
        }
        // PUT api/values/5
        public void Put(int id, [FromBody]string value) {
        }
        // DELETE api/values/5
        public void Delete(int id) {
        }
    }
}

到这里组件就搭完了，剩下的就是运行了。如果将 WebAPI 部署在 IIS 或其他服务器上，在浏览器 URL 里面敲地址 http://IP 地址：端口/Help 即可显示 WebApiTestClient 调试页面；这里可以直接通过 Visual Studio 调试弹出 WebApiTestClient 调试页面。

WebApiTestClient 调试页面展示：

接口调试：

点击某一个接口查看接口详细。例如本文查看 Get 请求的无参方法，右下角有按钮可以测试接口。

点击'Test API'按钮

点击 Send 发送请求

第二个有参数的接口

手动输入参数

点'Send'得到返回结果

总结

WebApiTestClient 是一种专门用于调试和测试 ASP.NET WebApi 的工具，具有以下优点：

1. 简洁易用：Web 界面，无需安装外部工具，易于集成。
2. 灵活的请求配置：支持多种 HTTP 方法，允许自定义请求头、请求体和查询参数。
3. 实时查看响应：即时查看 API 的响应结果，包括状态码、响应头和响应体。
4. 提高开发效率：快速验证 API 功能，减少前后端联调时间。
5. 便于展示和沟通：适合需求评审或技术交流过程中的实时演示。
6. 配置灵活：适应不同项目的需求，适用于开发和测试环境。
7. 无需依赖外部工具：内置解决方案，减少环境配置和维护复杂度。

WebApiTestClient 以其简洁易用、灵活配置、即时反馈等优点，成为了调试和测试 ASP.NET WebApi 的理想工具。它不仅提高了开发和测试效率，而且在前后端联调、需求评审等场景中也发挥了重要作用。