在.NET 開發領域，模擬外部API呼叫不僅是一項技術挑戰，更是確保系統整體效能的重要手段。
本文將探討如何在.NET環境中實作整合測試，並模擬外部API呼叫。
什麽是整合測試
整合測試，作為單元測試的後續步驟，其核心目的在於驗證不同模組間的介面和互動是否順暢。
在.NET 的世界裏，這意味著API端點必須能夠準確無誤地處理來自外部服務的請求。但是實際情況下，外部服務可能無法在測試環境中請求，或者有請求頻率的限制。
為了保證測試的連續性和穩定性，我們可以借助WireMock.Net這樣的庫來建立HTTP響應的存根和模擬，從而在不依賴真實外部服務的前提下進行全面測試。
WireMock.Net是.NET開發者的得力助手，它使得模擬外部API響應變得簡單而高效。透過這種方式，開發者可以在完全控制的環境中測試API，確保在部署前就能發現並修復潛在的問題。
範例程式碼
想象一下，我們有一個API程式，它的任務是從外部服務獲取天氣預報數據。通常情況下，這些服務的地址會在配置檔中定義，如下所示：
"MySettings": {
"Url": "http://www.example.com"
}
在進行整合測試時，我們希望將測試與外部服務的實際狀態解耦，以避免不必要的幹擾。這時，WireMock.Net就能發揮作用，透過模擬外部服務，我們可以定義期望的請求路徑和方法，並指定模擬響應的內容。
當API向這個預設路徑發送GET請求時，模擬伺服器會返回我們定義好的響應，使我們能夠在隔離的環境中對API的行為進行準確的驗證。
為了實作這一切，我們首先需要建立一個xunit測試計畫，並引入Microsoft.AspNetCore.Mvc.Testing包。在計畫檔中，我們指定使用Web SDK，如下所示：
<ProjectSdk="Microsoft.NET.Sdk.Web">
<!-- ... -->
</Project>
接下來，我們利用
WebApplicationFactory<TEntryPoint>
建立一個自訂工廠，這個工廠負責構建Web主機配置。
在這個自訂工廠中，我們啟動模擬伺服器，並將API程式的配置資訊指向模擬伺服器的地址：
public class CustomWebApplicationFactory<TProgram>
: WebApplicationFactory<TProgram> where TProgram : class
{
protected override void ConfigureWebHost(IWebHostBuilder builder)
{
var mockApiServer = WireMockServer.Start(server =>
{
server.Urls = new[] { "http://localhost:58888" };
});
mockApiServer.Given(Request.Create()
.WithPath("/weatherforecast")
.UsingGet())
.RespondWith(Response.Create()
.WithHeader("content-type", "application/json")
.WithBodyAsJson(new WeatherForecast { TemperatureC= "MOCK Temperature" })
.WithStatusCode(System.Net.HttpStatusCode.OK));
builder.ConfigureServices(services =>
{
services.AddSingleton<IOptions<MySettings>>(container =>
{
return Options.Create( new MySettings { Url = mockApiServer.Url });
});
});
}
}
設定模擬伺服器時，我們會定義一系列規則，包括請求的路徑、HTTP方法和響應的狀態碼。我們還可以自訂響應頭和正文，以模擬真實API的響應。例如，我們可以設定一個規則，當請求路徑為"/weatherforecast"時，返回一個包含
WeatherForecast
物件的JSON響應。這樣，我們就能在不實際呼叫外部服務的情況下，測試API的邏輯處理能力。
最後，我們編寫測試類並執行整合測試，確保每一個環節都符合預期：
public class UnitTest1 : I classFixture<CustomWebApplicationFactory<Program>>
{
private readonly CustomWebApplicationFactory<Program> _factory;
public UnitTest1(CustomWebApplicationFactory<Program> factory)
{
_factory = factory;
}
[Fact]
public async Task Test1()
{
var response = await _factory.CreateClient().GetAsync("demo1");
var result = await response.Content.ReadFromJsonAsync<WeatherForecast>();
Assert.Equal("MOCK Temperature", result.TemperatureC);
}
}
總結
模擬外部API呼叫是.NET API整合測試中不可或缺的一環。它不僅提升了測試的效率和可靠性，還使我們能夠更好地控制測試環境，確保測試結果的準確性。
透過使用WireMock.Net等工具，我們能夠構建一個靈活且可控的測試環境，為.NET API的穩定性和可靠性提供堅實的保障。
