.NET中测试调用外部API的方法：如何Mock内部API调用？

问题场景 #

需要测试ConfigController的MainMethod，但该方法直接调用了类内部的MakeApiCall方法（此方法会请求外部API），希望测试时不依赖外部API的可用性，确保测试失败仅源于自身代码问题，但不知道如何Mock内部方法。

你的代码示例：

public class ConfigController : ControllerBase
{
  ...
   [HttpPost("GetValue")]
   public async Result MainMethod(int id){
    ...
    response = MakeApiCall(id)
    ...
    return response.value + some stuff
   }


   public async Result MakeApiCall(int id){
   return GetAsync(otherAPIurl/id={id});
   }
 }

解决方案 #

方案1：将内部方法改为虚方法，使用Moq Mock #

如果不想大幅重构现有代码，可以将MakeApiCall标记为virtual，这样就能用Moq等Mock框架模拟这个方法的返回值，隔离外部API调用。

修改Controller：

public class ConfigController : ControllerBase
{
  ...
   [HttpPost("GetValue")]
   public async Result MainMethod(int id){
    ...
    response = MakeApiCall(id)
    ...
    return response.value + some stuff
   }

   // 改为virtual方法
   public virtual async Result MakeApiCall(int id){
   return GetAsync(otherAPIurl/id={id});
   }
 }

编写单元测试（以xUnit + Moq为例）：

public class ConfigControllerTests
{
    [Fact]
    public async Task MainMethod_ShouldReturnCorrectValue_WhenMakeApiCallReturnsMockedResponse()
    {
        // Arrange
        var mockController = new Mock<ConfigController>();
        // 设置CallBase为true，确保除Mock方法外执行真实逻辑
        mockController.CallBase = true;
        // Mock MakeApiCall的返回值
        var mockedResult = new Result { value = "mockValue" };
        mockController.Setup(c => c.MakeApiCall(It.IsAny<int>()))
                      .ReturnsAsync(mockedResult);

        var controller = mockController.Object;

        // Act
        var result = await controller.MainMethod(123);

        // Assert
        Assert.Equal("mockValue + some stuff", result);
        mockController.Verify(c => c.MakeApiCall(123), Times.Once);
    }
}

方案2：重构代码，抽离外部API调用为依赖服务 #

如果希望代码符合依赖注入原则（SOLID），可以把外部API调用逻辑抽成独立的服务接口和实现，通过构造函数注入到Controller中，这种方式更灵活且利于维护。

定义接口与实现：

public interface IExternalApiService
{
    Task<Result> GetValueFromApi(int id);
}

public class ExternalApiService : IExternalApiService
{
    public async Task<Result> GetValueFromApi(int id)
    {
        return await GetAsync($"{otherAPIurl}/id={id}");
    }
}

修改Controller注入依赖：

public class ConfigController : ControllerBase
{
    private readonly IExternalApiService _externalApiService;

    public ConfigController(IExternalApiService externalApiService)
    {
        _externalApiService = externalApiService;
    }

    [HttpPost("GetValue")]
    public async Result MainMethod(int id){
        ...
        response = await _externalApiService.GetValueFromApi(id);
        ...
        return response.value + some stuff
    }
 }

编写单元测试：

public class ConfigControllerTests
{
    [Fact]
    public async Task MainMethod_ShouldReturnCorrectValue_WhenExternalApiReturnsMockedResponse()
    {
        // Arrange
        var mockApiService = new Mock<IExternalApiService>();
        var mockedResult = new Result { value = "mockValue" };
        mockApiService.Setup(s => s.GetValueFromApi(123))
                      .ReturnsAsync(mockedResult);

        var controller = new ConfigController(mockApiService.Object);

        // Act
        var result = await controller.MainMethod(123);

        // Assert
        Assert.Equal("mockValue + some stuff", result);
        mockApiService.Verify(s => s.GetValueFromApi(123), Times.Once);
    }
}

方案3：使用隔离框架（付费/高级选项） #

如果既不能修改现有代码（比如无法标记方法为virtual），也不想重构，可以使用TypeMock Isolator这类隔离框架，它支持Mock非虚方法、静态方法等，但这类工具通常需要付费授权。

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