Services
Technology Web App Development Mobile App Development Windows App Development Database Development UI/UX Development Cloud Development SEO Digital Marketing Guest Posting Content Writing Artificial Intelligence Data Science ERP Development CRM Development CMS Development LMS Development Business Listing Blockchain Technology Startup Promotion AI Tools Integration
Products
Data Converter Cleaner TUC - Unit Converter Import Export Survey Manager Tweet Controller
Developer
Article Blog Forum Interview Beginner News Startup Quiz
Users
Career
Apply Job Internship
Pricing
Login Sign Up Get a Quote

interview

Home Interviews How would you structure unit tests for an ASP.NET Web API controller? – MindStick
Ask Question

1 Answers

ICSM Computer
ICSM Computer 17 Jun 2025
Report Abuse

To structure unit tests for an ASP.NET Web API controller, you should isolate the controller logic and mock dependencies. Here’s a clean and testable approach:

1. Structure Your Project

Organize your solution like this:

MyApp/
│
├── MyApp.Api/               → ASP.NET Web API project
│   └── Controllers/
│       └── UsersController.cs
│
├── MyApp.Tests/             → Test project (use xUnit, NUnit, or MSTest)
    └── Controllers/
        └── UsersControllerTests.cs

2. Ensure Controller Follows SOLID

Controllers should:

  • Use Dependency Injection (DI) for services.
  • Have thin logic: delegate to service layers.
  • Return standard types: IHttpActionResult, ActionResult<T>, etc.

Example Controller (simplified):

public class UsersController : ApiController
{
    private readonly IUserService _service;

    public UsersController(IUserService service)
    {
        _service = service;
    }

    [HttpGet]
    public IHttpActionResult GetUser(int id)
    {
        var user = _service.GetUser(id);
        if (user == null)
            return NotFound();
        return Ok(user);
    }
}

3. Setup Unit Test Project

a. Install Test Tools:

In MyApp.Tests.csproj:

dotnet add package xunit
dotnet add package Moq
dotnet add package Microsoft.AspNet.WebApi

b. Create Unit Test:

public class UsersControllerTests
{
    private readonly Mock<IUserService> _mockService;
    private readonly UsersController _controller;

    public UsersControllerTests()
    {
        _mockService = new Mock<IUserService>();
        _controller = new UsersController(_mockService.Object);
    }

    [Fact]
    public void GetUser_ReturnsOk_WhenUserExists()
    {
        // Arrange
        var user = new UserDto { Id = 1, Name = "Anna" };
        _mockService.Setup(s => s.GetUser(1)).Returns(user);

        // Act
        var result = _controller.GetUser(1) as OkNegotiatedContentResult<UserDto>;

        // Assert
        Assert.NotNull(result);
        Assert.Equal(1, result.Content.Id);
    }

    [Fact]
    public void GetUser_ReturnsNotFound_WhenUserDoesNotExist()
    {
        // Arrange
        _mockService.Setup(s => s.GetUser(1)).Returns((UserDto)null);

        // Act
        var result = _controller.GetUser(1);

        // Assert
        Assert.IsType<NotFoundResult>(result);
    }
}

4. Best Practices

  • Mock all external dependencies (DB, APIs, services).
  • Test only controller logic, not the service or DB.
  • Use [Theory] in xUnit for parameterized testing.
  • Test happy and unhappy paths: success, null, exception, bad input.
  • Ensure your controller method returns expected IHttpActionResult.

5. Common Tools

  • xUnit / NUnit / MSTest – test framework
  • Moq – mocking dependencies
  • FluentAssertions (optional) – more readable assertions
  • AutoFixture – for auto-generating test data (optional)
advertising
Markdown for AI

A clean, structured version of this page for AI assistants and LLMs.

Open .md