MVC Controllers are Dinosaurs - Embrace API Endpoints

Date Published: 20 January 2021

MVC Controllers are Dinosaurs - Embrace API Endpoints

I've been programming web applications using the MVC pattern for a very long time. What's more, I've been helping companies dig themselves out of technical debt for an even longer time, and I work with a wide variety of teams every year. So, I've seen things. And while I would absolutely never want to return to the old Web Forms way of building apps, I can tell you that more often than not, MVC Controllers are a source of pain in ASP.NET/ASP.NET Core projects.

MVC Controllers are essentially an antipattern. They're dinosaurs. They are collections of methods that never call one another and rarely operate on the same state. They're not cohesive. They tend to become bloated and to grow out of control. Their private methods, if any, are usually only called by a single public method. Most developers recognize that controllers should be as small as possible (unscientific poll), but they're the only solution offered out of the box, so that's the tool 99% of ASP.NET Core developers use.

Dino Comics MVC

You can use tools like MediatR to mitigate the problem. You can read a detailed article about how to migrate from Controllers to Endpoints using MediatR. The short version is that MediatR enables you to have single-line action methods that route commands to handlers. This is objectively a better approach, resulting in more cohesive classes that better follow OO principles. But what if you didn't even need that extra plumbing?

Now, to be clear, I'm talking about APIs here. What if you're still building things that respond directly to browser requests with HTML built on the server with Razor? Then you should probably be using Razor Pages or Blazor, both of which have already solved this problem.

Why Should I Use This Non-Standard Framework?

Well, here's the thing. API Endpoints are really just Controllers with a few constraints applied to them. I mean, literally, they inherit from ControllerBase. So, they're not non-standard in any way, and everything that works with Controllers, like routing, model binding, model validation, dependency injection, filters, etc. all works just fine with API Endpoints because, that's right, they're controllers.

But I don't need this constraint - I can do it myself!

Yes, it's true. You could just create controllers that followed Single Responsibility Principle and only did one thing. But you don't. Don't fall into the trap of thinking constraints are a bad thing - they're not. Constraints are a useful design tool that can lead to better quality.

Let's consider global, mutable state in software. Pretty much everybody agrees that directly modifying global state from many different functions, classes, and modules is a poor practice that leads to bugs that are hard to find and fix. So most languages offer some kind of scope for local variables and arguments, and most object-oriented languages like C# take this even further and offer a variety of ways to protect and encapsulate variables using keywords like private, protected, and internal. "But we don't need these constraints - we can just use a naming convention on our global variables to do the same thing!"

Yeah, you could. Let me know how that works out. The rest of us will be using constraints to help guide our teams and our software into the pit of success.

Ok I'm Interested - How Do I Get Started

Easy. I suggest reading the repo's README file as a good place to start. It covers a bit of the same things I've covered here, but has code listings and more as well. The repo also has a sample project you can look at to see some ways to use the Request-EndPoint-Response or REPR pattern.

If you want to see some other open source projects that use the approach, have a look at my Clean Architecture solution template and the eShopOnWeb reference app from Microsoft.

If you have a project already and you just want to get started using API Endpoints instead of Controllers (and possibly MediatR), just add the Ardalis.ApiEndpoints NuGet package and then create endpoints by inheriting from the BaseEndpoint or BaseAsyncEndpoint types.

Request EndPoint Response (REPR) Pattern

MVC - Model-View-Controller is designed to work with user interfaces. The View is a UI component, obviously. If you're building APIs, there are no Views, so at best you're using the MC pattern, or maybe you can call it Model-Action-Controller and get the MAC pattern. The point is, you're already not using MVC for your APIs, so it shouldn't be a big stretch to think about a more appropriate pattern.

API Endpoints are pretty self-contained and each one can be described using three components:

  • Request: The shape of the data the endpoint expects
  • Endpoint: The logic the endpoint performs given a request
  • Response: The response the endpoint returns to the caller

Combining these three elements, you get the Request-EndPoint-Response or REPR pattern, which I pronounce "reaper". (yes, you could go with RER but the "rurr" pattern just doesn't sound as interesting).

Not all endpoints will require actual data for their request or response, in some cases taking in no inputs or returning just an HTTP status code. But an empty request or response is still a valid one in this pattern, just as some MVC actions don't require a model.

When using the API Endpoints library, you can group your request, endpoint, and response types together, so that you don't need to go digging around inside some "viewmodels" or "dtos" folder looking for the appropriate types. It reduces friction and makes working with individual endpoints much easier.

Tell Me What You Think

If you try this approach, please let me know how it works for you. If you need a feature that's somehow not supported, please add an issue and/or a pull request. If you find that it's working well and helping you write simpler code with smaller classes that each do just one thing, share the project on social media. And of course, you can always leave a comment below.

You can also give the repo a star to help others discover the repo. It's been growing pretty steadily in popularity according to star-history:

star history of ardalis/endpoints

Thanks!

Steve Smith

About Ardalis

Software Architect

Steve is an experienced software architect and trainer, focusing on code quality and Domain-Driven Design with .NET.


Ardalis

Copyright © 2021