The order between AddMvc/AddSwaggerGen and UseMvc/UseSwagger(UI)

user_1525840 0
Viewed 1289

When I power my APIs with Swagger, I follow one of those guids and I always put the MVC injections before Swagger injections like this.

services.AddMvc();
services.AddSwaggerGen(_ => { ... });

app.UseMvc();
app.UseSwagger();
app.UseSwaggerUI(c => { ... });

A friend of mine asked why I apply that order and not handle the Swagger related lines first, before MVC. I discovered that I couldn't explain that to him nor motivate it (other than a very embarrassed well... that's the way it is...). That tells me that I should dig a bit into that matter.

Short googling revealed nothing of relevance as far I've noticed, so I'm asking here.

swagger-3.0 asp.net-core-2.2 swagger asp.net-core c#
1 Answers

In this particular case, Add* is not affected by the order they are added to the service collection.

However, depending on the implementation of the particular Add* extension, the order may affect configuration. For example, if internally it uses the TryAdd* extension, then only the first call registers. Subsequent calls wont add as a registration would already exist.

The general AddScoped/AddSingleton/AddTransient calls recognizes the last call for a type as it overrides the previous registration calls for that type. When registering multiple implementations for a type, for resolving via IEnumerable<T> then the implementations in the collection will be in the order they were registered.

Reference Dependency injection in ASP.NET Core

For the Use* middleware the order they are added to the pipeline is important as they are invoked in the same order.

Order

The order that middleware components are added in the Startup.Configure method defines the order in which the middleware components are invoked on requests and the reverse order for the response. The order is critical for security, performance, and functionality.

Reference ASP.NET Core Middleware

In my experience, depending on their designed purpose, some 3rd party integrations (including swagger) that need access to the pipeline suggest adding their extensions after AddMvc to try and avoid route conflicts.

Most security (Authentication/Authorization) and logging middleware are usually suggested to be added early in the pipeline, so they tend to come before AddMvc.

user_52334100
Related