Skip to content
Clean Web API
Lean Mean Clean Apps

Five templates, one brand, one search box. Everything in the docs is in here, including the bits we hoped you'd skim.

Try one of these

Results say which template they came from, so you won't end up reading about Lambda when you wanted GraphQL. Again.

Make it yours

Sooner or later you’ll want to evict Deep Space Gardeners and move your own domain in. The tempting move is to delete Movies, Authors and Reviews first. Don’t. Half the tests stop compiling, and the shared plumbing (paging, validation, logging, OpenAPI and telemetry) suddenly has nothing to exercise it, so coverage falls through the floor.

Go the other way round. Build your first slice beside the sample domain, prove it works end to end, then take the movies out. This guide adds cinemas, with GET /api/cinemas to list and search them and POST /api/cinemas to create one, and finishes with a solution that has no movies left in it. We ran every step on a fresh solution: it ends with 76 passing tests and 99.7% line coverage.

The code below assumes you named the solution WorksOnMyMachine.Movies. Swap in your own name wherever you see it.

  1. Add the entity and use cases to src/Application (add-a-use-case).

    The entity, the repository interface, one query and one command, each with a validator. Handlers and validators are public, like the samples, so Mediator’s source generator and the tests can see them.

    • Directorysrc/Application/Cinemas/
      • Entities/Cinema.cs
      • ICinemasRepository.cs
      • DirectoryQueries/GetCinemas/
        • GetCinemasQuery.cs
        • GetCinemasHandler.cs
        • GetCinemasValidator.cs
      • DirectoryCommands/CreateCinema/
        • CreateCinemaCommand.cs
        • CreateCinemaHandler.cs
        • CreateCinemaValidator.cs
    src/Application/Cinemas/Entities/Cinema.cs
    namespace WorksOnMyMachine.Movies.Application.Cinemas.Entities;
    /// <summary>
    /// A cinema that shows movies.
    /// </summary>
    /// <param name="Id">The unique identifier of the cinema.</param>
    /// <param name="Name">The name of the cinema.</param>
    public record Cinema(Guid Id, string Name);
    src/Application/Cinemas/ICinemasRepository.cs
    namespace WorksOnMyMachine.Movies.Application.Cinemas;
    using Common.Paging;
    using Entities;
    public interface ICinemasRepository
    {
    public Task<Page<Cinema>> GetCinemas(
    string? query,
    PageRequest page,
    CancellationToken cancellationToken);
    public Task<Cinema> CreateCinema(string name, CancellationToken cancellationToken);
    }

    The query reuses the shared paging and search rules, so Common/Paging stays covered once the sample queries are gone.

    src/Application/Cinemas/Queries/GetCinemas/GetCinemasQuery.cs
    namespace WorksOnMyMachine.Movies.Application.Cinemas.Queries.GetCinemas;
    using Common.Paging;
    using Entities;
    using Mediator;
    /// <summary>
    /// Lists cinemas one page at a time, optionally only those whose name contains a search term.
    /// </summary>
    public class GetCinemasQuery : IRequest<Page<Cinema>>
    {
    /// <summary>The words to look for in the name, ignoring case. Leave empty to list every cinema.</summary>
    public string? Query { get; init; }
    /// <summary>The number of results to skip, 0 for the first page.</summary>
    public int Offset { get; init; }
    /// <summary>The largest number of results to return, from 1 to 50.</summary>
    public int Limit { get; init; } = Paging.DefaultLimit;
    }
    src/Application/Cinemas/Queries/GetCinemas/GetCinemasHandler.cs
    namespace WorksOnMyMachine.Movies.Application.Cinemas.Queries.GetCinemas;
    using Common.Paging;
    using Entities;
    using Mediator;
    public class GetCinemasHandler(ICinemasRepository repository) : IRequestHandler<GetCinemasQuery, Page<Cinema>>
    {
    public async ValueTask<Page<Cinema>> Handle(GetCinemasQuery request, CancellationToken cancellationToken)
    {
    return await repository.GetCinemas(request.Query, new PageRequest(request.Offset, request.Limit), cancellationToken);
    }
    }
    src/Application/Cinemas/Queries/GetCinemas/GetCinemasValidator.cs
    namespace WorksOnMyMachine.Movies.Application.Cinemas.Queries.GetCinemas;
    using Common.Paging;
    using FluentValidation;
    public class GetCinemasValidator : AbstractValidator<GetCinemasQuery>
    {
    public GetCinemasValidator()
    {
    _ = this.RuleFor(r => r.Query).ValidSearchTerm();
    _ = this.RuleFor(r => r.Offset).ValidOffset();
    _ = this.RuleFor(r => r.Limit).ValidLimit();
    }
    }
    src/Application/Cinemas/Commands/CreateCinema/CreateCinemaCommand.cs
    namespace WorksOnMyMachine.Movies.Application.Cinemas.Commands.CreateCinema;
    using Entities;
    using Mediator;
    public class CreateCinemaCommand : IRequest<Cinema>
    {
    public string Name { get; init; } = string.Empty;
    }
    src/Application/Cinemas/Commands/CreateCinema/CreateCinemaHandler.cs
    namespace WorksOnMyMachine.Movies.Application.Cinemas.Commands.CreateCinema;
    using Entities;
    using Mediator;
    public class CreateCinemaHandler(ICinemasRepository repository) : IRequestHandler<CreateCinemaCommand, Cinema>
    {
    public async ValueTask<Cinema> Handle(CreateCinemaCommand request, CancellationToken cancellationToken)
    {
    return await repository.CreateCinema(request.Name, cancellationToken);
    }
    }
    src/Application/Cinemas/Commands/CreateCinema/CreateCinemaValidator.cs
    namespace WorksOnMyMachine.Movies.Application.Cinemas.Commands.CreateCinema;
    using FluentValidation;
    public class CreateCinemaValidator : AbstractValidator<CreateCinemaCommand>
    {
    public CreateCinemaValidator()
    {
    _ = this.RuleFor(r => r.Name).NotEmpty().WithMessage("A cinema needs a name.");
    _ = this.RuleFor(r => r.Name).MaximumLength(100).WithMessage("A cinema name can't be longer than 100 characters.");
    }
    }
  2. Store and map it in src/Infrastructure (data-access-ef-core and mapping-with-mapperly).

    Add the database model and its configuration beside the sample ones. Every model inherits Entity, which brings the id and the created and modified dates, and every configuration inherits EntityConfiguration<T>, which sets them up.

    src/Infrastructure/Databases/MovieReviews/Models/Cinema.cs
    namespace WorksOnMyMachine.Movies.Infrastructure.Databases.MovieReviews.Models;
    using System.Diagnostics.CodeAnalysis;
    [ExcludeFromCodeCoverage]
    internal record Cinema : Entity
    {
    public required string Name { get; init; }
    }
    src/Infrastructure/Databases/MovieReviews/Configuration/CinemaConfiguration.cs
    namespace WorksOnMyMachine.Movies.Infrastructure.Databases.MovieReviews.Configuration;
    using Microsoft.EntityFrameworkCore;
    using Microsoft.EntityFrameworkCore.Metadata.Builders;
    using Models;
    internal class CinemaConfiguration : EntityConfiguration<Cinema>
    {
    public override void Configure(EntityTypeBuilder<Cinema> builder)
    {
    base.Configure(builder);
    _ = builder.Property(c => c.Name).HasMaxLength(100).UseCollation(Collations.NoCase);
    _ = builder.HasIndex(c => c.Name);
    }
    }

    Then wire it in:

    • MovieReviewsDbContext.cs: add public DbSet<Cinema> Cinemas => this.Set<Cinema>(); beside the other sets.

    • Mapping/MovieReviewsMapper.cs: add using AppCinema = Application.Cinemas.Entities.Cinema; and using InfraCinema = Models.Cinema; with the other aliases, and this method:

      [MapperIgnoreSource(nameof(InfraCinema.DateCreated))]
      [MapperIgnoreSource(nameof(InfraCinema.DateModified))]
      public partial AppCinema ToDomain(InfraCinema cinema);
    • EntityFrameworkMovieReviewsRepository.cs: add using Application.Cinemas; and using ApplicationCinema = Application.Cinemas.Entities.Cinema;, add ICinemasRepository to the interfaces the class implements, and add a Cinemas region. The search reuses the repository’s own ContainsPattern and EscapeCharacter, so a % or _ in a search term matches itself, the same as for movies.

      #region Cinemas
      public async Task<Page<ApplicationCinema>> GetCinemas(
      string? query,
      PageRequest page,
      CancellationToken cancellationToken)
      {
      var cinemas = this.context.Cinemas.AsQueryable();
      if (!string.IsNullOrWhiteSpace(query))
      {
      var pattern = ContainsPattern(query);
      cinemas = cinemas.Where(c => EF.Functions.Like(c.Name, pattern, EscapeCharacter));
      }
      var totalCount = await cinemas.CountAsync(cancellationToken);
      var result = await cinemas
      .OrderBy(c => c.Name)
      .ThenBy(c => c.Id)
      .Skip(page.Offset)
      .Take(page.Limit)
      .ToListAsync(cancellationToken);
      return new([.. result.Select(this.mapper.ToDomain)], page.Offset, page.Limit, totalCount);
      }
      public async Task<ApplicationCinema> CreateCinema(string name, CancellationToken cancellationToken)
      {
      var now = this.timeProvider.GetUtcNow().UtcDateTime;
      var cinema = new Cinema
      {
      Name = name,
      DateCreated = now,
      DateModified = now
      };
      _ = this.context.Add(cinema);
      _ = await this.context.SaveChangesAsync(cancellationToken);
      return this.mapper.ToDomain(cinema);
      }
      #endregion Cinemas
    • src/Infrastructure/DependencyInjection.cs: add using Application.Cinemas; and register the interface against the same repository, like the others:

      _ = services.AddScoped<ICinemasRepository>(x =>
      x.GetRequiredService<EntityFrameworkMovieReviewsRepository>());
    • Extensions/MovieReviewsDbContextExtensions.cs (sample-data): give local and docker some cinemas to look at. Add this to AddData before SaveChanges:

      var cinemas = new Faker<Cinema>()
      .UseSeed(Seed)
      .RuleFor(c => c.Id, f => f.Random.Guid())
      .RuleFor(c => c.Name, f => $"{f.Address.City()} Picture House")
      .RuleFor(c => c.DateCreated, f => f.Date.Past(refDate: ReferenceDate))
      .RuleFor(c => c.DateModified, f => f.Date.Past(refDate: ReferenceDate))
      .Generate(5);
      context.AddRange(cinemas);
  3. Add a migration (database-migrations).

    Terminal window
    dotnet tool install --global dotnet-ef
    dotnet ef migrations add AddCinemas \
    --project ./src/Infrastructure \
    --output-dir Databases/MovieReviews/Migrations \
    --namespace WorksOnMyMachine.Movies.Infrastructure.Databases.MovieReviews.Migrations
    sed -i '1s/^\xEF\xBB\xBF//' src/Infrastructure/Databases/MovieReviews/Migrations/*.cs

    Without --namespace the migration lands in a namespace of its own. The sed strips the byte order mark the tool adds. On macOS, use sed -i ''. Then make // <auto-generated /> the first line of the new <timestamp>_AddCinemas.cs, as it is in the other migrations, so the analysers leave generated code alone.

  1. Put it on a controller in src/Presentation (expose-a-use-case and xml-docs-and-openapi).

    The XML comments aren’t decoration. They become the OpenAPI description, and a test fails if an operation or schema has none. Each controller gets its own folder under Controllers/, with its request models beside it.

    src/Presentation/Controllers/Cinemas/Requests/CreateCinemaRequest.cs
    namespace WorksOnMyMachine.Movies.Presentation.Controllers.Cinemas.Requests;
    /// <summary>
    /// The details needed to create a cinema.
    /// </summary>
    public class CreateCinemaRequest
    {
    /// <summary>
    /// The name of the cinema, up to 100 characters.
    /// </summary>
    /// <example>The Astor</example>
    public string Name { get; init; } = string.Empty;
    }
    src/Presentation/Controllers/Cinemas/CinemasController.cs
    namespace WorksOnMyMachine.Movies.Presentation.Controllers.Cinemas;
    using Application.Common.Paging;
    using Common;
    using Mediator;
    using Microsoft.AspNetCore.Mvc;
    using Requests;
    using Commands = Application.Cinemas.Commands;
    using Entities = Application.Cinemas.Entities;
    using Queries = Application.Cinemas.Queries;
    [Route("api/cinemas")]
    public class CinemasController(ISender sender) : ApiControllerBase(sender)
    {
    /// <summary>
    /// List Cinemas
    /// </summary>
    /// <remarks>
    /// Returns one page of cinemas, ordered by name. Add a search term to return only the cinemas whose name
    /// contains it, ignoring case. To fetch the next page, add the limit to the offset.
    ///
    /// Sample request:
    ///
    /// GET /api/cinemas?query=astor&amp;offset=0&amp;limit=10
    /// </remarks>
    /// <param name="query">The words to look for in the name, ignoring case. Leave it out to list every cinema.</param>
    /// <param name="offset">The number of cinemas to skip, 0 for the first page.</param>
    /// <param name="limit">The largest number of cinemas to return, from 1 to 50.</param>
    /// <response code="200">One page of Cinemas.</response>
    /// <response code="400">The search term, offset or limit is not valid.</response>
    /// <response code="500">An unexpected error occurred.</response>
    [HttpGet]
    [EndpointName(nameof(GetCinemas))]
    [ProducesResponseType(typeof(Page<Entities.Cinema>), StatusCodes.Status200OK, "application/json")]
    [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest, "application/problem+json")]
    [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError, "application/problem+json")]
    public async Task<ActionResult<Page<Entities.Cinema>>> GetCinemas(
    CancellationToken cancellationToken,
    [FromQuery] string? query = null,
    [FromQuery] int offset = 0,
    [FromQuery] int limit = Paging.DefaultLimit)
    {
    return this.Ok(await this.Sender.Send(new Queries.GetCinemas.GetCinemasQuery
    {
    Query = query,
    Offset = offset,
    Limit = limit
    }, cancellationToken));
    }
    /// <summary>
    /// Create a Cinema
    /// </summary>
    /// <remarks>
    /// Creates a cinema. The name can't be empty or longer than 100 characters.
    ///
    /// Sample request:
    ///
    /// POST /api/cinemas
    /// {
    /// "name": "The Astor"
    /// }
    /// </remarks>
    /// <param name="request">The cinema to create.</param>
    /// <response code="201">The Cinema that was created.</response>
    /// <response code="400">The request is not valid, for example the name is empty.</response>
    /// <response code="500">An unexpected error occurred.</response>
    [HttpPost]
    [EndpointName(nameof(CreateCinema))]
    [ProducesResponseType(typeof(Entities.Cinema), StatusCodes.Status201Created, "application/json")]
    [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest, "application/problem+json")]
    [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError, "application/problem+json")]
    public async Task<ActionResult<Entities.Cinema>> CreateCinema(CreateCinemaRequest request, CancellationToken cancellationToken)
    {
    var response = await this.Sender.Send(new Commands.CreateCinema.CreateCinemaCommand
    {
    Name = request.Name
    }, cancellationToken);
    return this.StatusCode(StatusCodes.Status201Created, response);
    }
    }

    There’s no action that gets one cinema by its id yet, so the 201 has no Location header. Add a GetCinemaById and switch to this.CreatedAtAction, as ReviewsController.CreateReview does, when you need one.

    Then register it:

    • OpenApi/DocumentInfoTransformer.cs: add CreateTag("Cinemas", "Lookup all Cinemas, search them by name, or create new ones"), to the tags.
    • Presentation.http: add a request for each action, including one that fails validation.

    That’s all. MVC finds the controller by itself, the JSON options already cover the new types, and with --include-auth the [Authorize] on ApiControllerBase protects it.

  2. Test the new slice (test-design, unit-tests and integration-tests).

    Each new test has a sample test that already does the same job for movies or reviews. Copy it and rename it, and you have the shape, the names and the house style without having to think about them.

    • tests/Application.Tests.Unit/Cinemas/Queries/GetCinemas/GetCinemasHandlerTests.cs, copied from Movies/Queries/GetMovies/GetMoviesHandlerTests.cs.
    • tests/Application.Tests.Unit/Cinemas/Queries/GetCinemas/GetCinemasValidatorTests.cs, copied from Movies/Queries/GetMovies/GetMoviesValidatorTests.cs.
    • tests/Application.Tests.Unit/Cinemas/Commands/CreateCinema/CreateCinemaHandlerTests.cs, copied from Reviews/Commands/CreateReview/CreateReviewHandlerTests.cs.
    • tests/Application.Tests.Unit/Cinemas/Commands/CreateCinema/CreateCinemaValidatorTests.cs, copied from Reviews/Commands/CreateReview/CreateReviewValidatorTests.cs.
    • A Cinemas region in tests/Infrastructure.Tests.Integration/Databases/MovieReviews/EntityFrameworkMovieReviewsRepositoryTests.cs, copied from the Movies region: search, paging and create.
    • tests/Presentation.Tests.Integration/Controllers/CinemaEndpointTests.cs, copied from MovieEndpointTests.cs and ReviewEndpointTests.cs.

    The repository tests need some cinemas. Add three to AddTestData in tests/Infrastructure.Tests.Integration/Databases/MovieReviews/Extensions/MovieReviewsCollectionData.cs, named the same way as the sample rows:

    List<Cinema> cinemas =
    [
    new() { Id = Guid.NewGuid(), Name = "One" },
    new() { Id = Guid.NewGuid(), Name = "Two" },
    new() { Id = Guid.NewGuid(), Name = "Three" }
    ];
    context.Cinemas.AddRange(cinemas);

    Three existing tests in tests/Presentation.Tests.Integration/OpenApi/OpenApiDocumentTests.cs fail as soon as the endpoints exist. They’re doing their job: they pin down exactly what the API publishes.

    • GetOpenApiDocument_ShouldDescribe_Tags: add "Cinemas" to the expected tags.
    • GetOpenApiDocument_ShouldDescribe_EveryOperation: add 2 to the operation count, one for each new endpoint.
    • GetOpenApiDocument_ShouldDescribe_Schema: add [InlineData("Cinema")], [InlineData("PageOfCinema")] and [InlineData("CreateCinemaRequest")], so the new schemas have to be documented too.
    Terminal window
    dotnet build
    dotnet test
    dotnet format --verify-no-changes

    Both domains now run side by side. Stop here if you’re keeping the sample for reference, which is a perfectly respectable choice.

  1. Take out the sample movies, authors and reviews (sample-data and database-migrations).

    This step is mostly deleting, but the template’s own tests use the sample as their test subject, so a few of them change instead of going. Work through it layer by layer and build as you go. The compiler finds what’s left faster than any list.

    • Application: delete src/Application/Authors/, Movies/ and Reviews/. In Common/Enums/EntityType.cs, replace Author, Movie and Review with Cinema. NotFoundException uses it, and you’ll want it the day you add GetCinemaById.

    • Infrastructure: delete Author.cs, Movie.cs and Review.cs from Models/, and the matching *Configuration.cs files. Then remove from:

      • MovieReviewsDbContext.cs: their three DbSet properties.
      • MovieReviewsMapper.cs: their aliases and mapping methods.
      • EntityFrameworkMovieReviewsRepository.cs: the Authors, Movies, Reviews and Helpers regions, their using lines and aliases, and their three interfaces.
      • DependencyInjection.cs: their three registrations and using lines.
      • MovieReviewsDbContextExtensions.cs: the titles, the review texts and the author, movie and review fakers. Change the guard at the top of AddData to context.Cinemas.Any().
    • Presentation: delete Controllers/Authors/, Controllers/Movies/ and Controllers/Reviews/. Then remove from:

      • DocumentInfoTransformer.cs: their tags.
      • Presentation.http: the sample ids and requests.
    • Migrations: replace the history with one migration for your schema. With the old snapshot gone, the tool files the new one under a folder named after the namespace, so move it back beside the migration. Then add // <auto-generated /> to the first line of <timestamp>_InitialCreate.cs, as in step 3.

      Terminal window
      rm src/Infrastructure/Databases/MovieReviews/Migrations/*.cs
      dotnet ef migrations add InitialCreate \
      --project ./src/Infrastructure \
      --output-dir Databases/MovieReviews/Migrations \
      --namespace WorksOnMyMachine.Movies.Infrastructure.Databases.MovieReviews.Migrations
      mv src/Infrastructure/WorksOnMyMachine/Movies/Infrastructure/Databases/MovieReviews/Migrations/MovieReviewsDbContextModelSnapshot.cs \
      src/Infrastructure/Databases/MovieReviews/Migrations/
      rm -r src/Infrastructure/WorksOnMyMachine
      sed -i '1s/^\xEF\xBB\xBF//' src/Infrastructure/Databases/MovieReviews/Migrations/*.cs

      Delete src/Presentation/movie-reviews.db too, if you’ve run the API. It still holds the old tables, and the new migration history won’t recognise it.

    • Tests to delete:

      • tests/Application.Tests.Unit/: the Authors/, Movies/ and Reviews/ folders.
      • tests/Presentation.Tests.Integration/Controllers/: AuthorEndpointTests.cs, MovieEndpointTests.cs and ReviewEndpointTests.cs.
      • EntityFrameworkMovieReviewsRepositoryTests.cs: the Authors, Movies and Reviews regions.
      • MovieReviewsCollectionData.cs: the author, movie and review rows.
    • Tests to change: these test the template’s plumbing, and they used the sample as their subject. Point them at cinemas.

      • Common/Behaviours/LoggingBehaviourTests.cs and ValidationBehaviourTests.cs: Use CreateCinemaCommand, CreateCinemaValidator and Cinema in place of GetAuthorByIdQuery, its validator and Author. The invalid case is an empty Name, so the expected property is Name. The logged message names CreateCinemaCommand.
      • Common/Exceptions/NotFoundExceptionTests.cs: Use EntityType.Cinema and a Cinema. The message becomes “The Cinema with the supplied id was not found.”
      • MovieReviewsConfigurationTests.cs: Check a cinema loads, ignoring case: look up "one" and expect "One".
      • DependencyInjectionTests.cs: Expect ICinemasRepository, 5 seeded cinemas and none when seeding is off. Use GetCinemas for the concurrency and same-sample-data checks.
      • Telemetry/TelemetryTests.cs: Call /api/cinemas?limit=5 and expect a GetCinemasQuery span.
      • OpenApi/OpenApiDocumentTests.cs: Expect the tags Cinemas and Version, 3 operations, and the schemas Cinema, PageOfCinema, CreateCinemaRequest and VersionInfo.
      • Authentication/AuthenticationTests.cs, only with --include-auth: Replace the movie, author and review routes with /api/cinemas.
  2. Check it the way CI will (coverage).

    Terminal window
    dotnet build
    dotnet format --verify-no-changes
    dotnet test -m:1 \
    -p:CollectCoverage=true -p:CoverletOutput=../results/ -p:MergeWith="../results/coverage.json" \
    -p:CoverletOutputFormat=opencover%2cjson \
    -p:ExcludeByFile="**/Program.cs%2c**/Migrations/*.cs%2c**/obj/**/*.cs" \
    -p:ExcludeByAttribute="GeneratedCodeAttribute"

    The last table it prints is the merged total. Ours came out at 99.7%. If yours is under 95%, coverage says what to do about it, and it isn’t “lower the number”.

The database plumbing keeps its sample name: the Databases/MovieReviews folder, MovieReviewsDbContext, EntityFrameworkMovieReviewsRepository, the MovieReviews connection string and the movie-reviews.db file. They all work as they are. Everything in src/Infrastructure apart from DependencyInjection is internal, so renaming them later is a refactor that never reaches Application or Presentation. Do it when the name starts to bother you, and change the connection string in every appsettings.*.json and in docker-compose.yml at the same time.