ASP.NET Web API versioning Migrate from QueryStringApiVersionReader to UrlSegmentApiVersionReader

[barbosatekBU]

ASP.NET Web API versioning Migrate from QueryStringApiVersionReader to UrlSegmentApiVersionReader

[barbosatekBU]

Thanks, that answers my question. Closing now.

[commonsensesoftware]

Sorry to hear you're moving away from the RESTful approach, but I'm sure you have your reasons.

The combination of the QueryStringApiVersionReader and UrlSegmentApiVersionReader is the default, supported configuration as can be seen here:

aspnet-api-versioning/src/Common/src/Common/ApiVersioningOptions.cs

Line 75 in 471eb04

get => apiVersionReader ??= Versioning.ApiVersionReader.Default;

and here:

aspnet-api-versioning/src/Common/src/Common/ApiVersionReader.cs

Line 25 in 471eb04

public static IApiVersionReader Default => @default ??= Combine( new QueryStringApiVersionReader(), new UrlSegmentApiVersionReader() );

I think the misunderstanding is that you have to retain both routes. You can start with the most vanilla configuration:

builder.Services.AddApiVersioning();

Assuming you started with 1.0, then you might have something like this:

[ApiVersion(1.0)]
[ApiController]
[Route("[controller]")]
[Route("v{version:apiVersion}/[controller]")]
public class ArticlesController : ControllerBase
{
    [HttpGet]
    public IActionResult Get() => Ok();
}

[ApiVersion(2.0)]
[ApiController]
[Route("v{version:apiVersion}/articles")]
public class Articles2Controller : ControllerBase
{
    [HttpGet]
    public IActionResult Get() => Ok();
}

Without any further configuration, you'll now have the following routes:

Version	URL	Controller
1.0	articles?api-version=1.0	ArticlesController
1.0	v1/articles	ArticlesController
2.0	articles?api-version=2.0	400
2.0	v2/articles	Articles2Controller

If you have more versions, then you'll have to continue to repeat this process. Eventually, you'll be able to create single route templates for new versions once the old versions have been completely sunset. I hope that helps clear things up.