在 ASP.NET Web API 中進行單元測試是一種確保代碼質量和功能正確性的重要實踐。單元測試的重點是針對 API 控制器中的邏輯進行測試，而不依賴于外部依賴（如數據庫、文件系統或網絡請求）。以下是實現 ASP.NET Web API 單元測試的步驟和方法：

---

1.?設置測試項目

• 在你的解決方案中，添加一個新的測試項目。可以使用以下工具：
  • xUnit：推薦的現代單元測試框架。
  • NUnit?或?MSTest：也可以使用，但 xUnit 更加流行。
• 安裝必要的 NuGet 包：
  • Microsoft.AspNetCore.Mvc.Testing：用于模擬 Web API 環境。
  • 測試框架相關的包（如?xunit?和?xunit.runner.visualstudio）。

---

2.?創建被測控制器

假設你有一個簡單的 API 控制器如下：

[ApiController]
[Route("api/[controller]")]
public class SampleController : ControllerBase
{private readonly ISampleService _sampleService;public SampleController(ISampleService sampleService){_sampleService = sampleService;}[HttpGet("{id}")]public IActionResult GetById(int id){var result = _sampleService.GetDataById(id);if (result == null){return NotFound();}return Ok(result);}
}

---

3.?編寫單元測試

a. 使用 Mock 框架模擬依賴

為了隔離測試目標（即控制器），需要對依賴項（如 ISampleService）進行模擬。常用 Mock 框架包括：

• Moq
• NSubstitute

安裝 Moq：

dotnet add package Moq

b. 編寫測試代碼

以下是一個使用 xUnit 和 Moq 的單元測試示例：

using Microsoft.AspNetCore.Mvc;
using Moq;
using Xunit;public class SampleControllerTests
{[Fact]public void GetById_ReturnsOkResult_WhenDataExists(){// Arrangevar mockService = new Mock<ISampleService>();mockService.Setup(service => service.GetDataById(1)).Returns("Sample Data");var controller = new SampleController(mockService.Object);// Actvar result = controller.GetById(1);// Assertvar okResult = Assert.IsType<OkObjectResult>(result);Assert.Equal("Sample Data", okResult.Value);}[Fact]public void GetById_ReturnsNotFound_WhenDataDoesNotExist(){// Arrangevar mockService = new Mock<ISampleService>();mockService.Setup(service => service.GetDataById(1)).Returns((string)null);var controller = new SampleController(mockService.Object);// Actvar result = controller.GetById(1);// AssertAssert.IsType<NotFoundResult>(result);}
}

---

4.?集成測試（可選）

如果你需要測試整個 HTTP 請求管道（包括路由、中間件等），可以使用 Microsoft.AspNetCore.Mvc.Testing?進行集成測試。

示例代碼：

using Microsoft.AspNetCore.Mvc.Testing;
using Xunit;public class SampleControllerIntegrationTests : IClassFixture<WebApplicationFactory<Startup>>
{private readonly WebApplicationFactory<Startup> _factory;public SampleControllerIntegrationTests(WebApplicationFactory<Startup> factory){_factory = factory;}[Fact]public async Task GetById_ReturnsSuccessStatusCode(){// Arrangevar client = _factory.CreateClient();// Actvar response = await client.GetAsync("/api/sample/1");// Assertresponse.EnsureSuccessStatusCode(); // Status Code 200-299Assert.Equal("application/json; charset=utf-8", response.Content.Headers.ContentType.ToString());}
}

---

5.?運行測試

運行測試可以使用 Visual Studio 的測試資源管理器，或者通過命令行：

dotnet test

---

6. 最佳實踐

隔離性：確保每個測試只專注于一個功能點。

Mock 外部依賴：避免直接與數據庫或其他外部服務交互。

命名清晰：測試方法的名稱應清楚地描述測試場景和預期結果。

斷言明確：驗證返回值、狀態碼、異常等是否符合預期。

通過以上步驟，你可以為 ASP.NET Web API 編寫高效、可靠的單元測試，從而提升代碼質量并減少潛在問題。

?