如何不启动应用程序即可测试Web API客户端

方案1：使用ASP.NET Core内置In-Memory测试服务器（最适配当前场景） #

这是ASP.NET Core官方提供的集成测试工具，会在测试进程内启动轻量应用宿主，无需占用真实端口、无需提前启动应用进程，所有HTTP请求均在内存内转发，完全兼容你用swagger生成的HTTP客户端测试场景。

操作步骤 #

• 给测试项目安装NuGet依赖：Microsoft.AspNetCore.Mvc.Testing
• 在测试项目中创建自定义测试工厂，指向API项目的启动类：

public class CustomWebApplicationFactory<TProgram> : WebApplicationFactory<TProgram> where TProgram : class
{
    // 可重写配置替换服务，比如将真实数据库替换为内存库、替换第三方依赖为Mock对象
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        builder.ConfigureServices(services =>
        {
            // 示例：替换数据库上下文为内存数据库，避免操作真实业务数据
            // var dbDescriptor = services.SingleOrDefault(d => d.ServiceType == typeof(你的数据库上下文类名));
            // services.Remove(dbDescriptor);
            // services.AddDbContext<你的数据库上下文类名>(opt => opt.UseInMemoryDatabase("TestDatabase"));
        });
    }
}

注意：如果你的API项目使用.NET 6及以上版本的顶层语句，需要在API项目的.csproj文件中添加如下配置，让测试项目可以访问内部隐式生成的Program类：

<ItemGroup>
  <InternalsVisibleTo Include="你的测试项目名称" />
</ItemGroup>

• 改造现有测试类，用测试工厂生成的客户端初始化swagger生成的API实例：

[TestFixture]
public class CategoriesApiTests
{
    private CategoriesApi _instance;
    private CustomWebApplicationFactory<Program> _testFactory;

    [SetUp]
    public void Init()
    {
        _testFactory = new CustomWebApplicationFactory<Program>();
        // 生成内存模式的HttpClient，不会走真实网络请求
        var httpClient = _testFactory.CreateClient();
        // 绝大多数swagger生成的客户端都支持直接传入HttpClient实例完成初始化
        _instance = new CategoriesApi(httpClient);
        // 如果你使用的客户端仅支持传入地址参数，可改为：_instance = new CategoriesApi(_testFactory.Server.BaseAddress.ToString());
    }

    [Test]
    public void InstanceTest()
    {
        Assert.IsInstanceOf<CategoriesApi>(_instance, "instance is a CategoriesApi");
    }

    [TearDown]
    public void Cleanup()
    {
        _testFactory.Dispose();
    }
}

方案2：完全Mock服务端响应（适合单元测试客户端逻辑） #

如果你不需要运行真实API的业务逻辑，仅需测试swagger客户端本身的序列化、异常处理等逻辑，可以用Mock工具模拟HTTP响应结果：

• 给测试项目安装NuGet依赖：Moq、RichardSzalay.MockHttp
• 模拟HTTP请求响应后初始化客户端即可：

var mockHttpHandler = new MockHttpMessageHandler();
// 模拟指定接口的返回结果
mockHttpHandler.When("http://localhost:5000/api/categories")
        .Respond("application/json", "[{\"id\":1,\"name\":\"测试分类\"}]");

var httpClient = mockHttpHandler.ToHttpClient();
httpClient.BaseAddress = new Uri("http://localhost:5000/");
// 用模拟的HttpClient初始化API实例
_instance = new CategoriesApi(httpClient);

内容的提问来源于stack exchange，提问作者user13569819