Api versioning (ARCH803)

Key dotnet.api.api-versioning · Severity info · Category api

Changing an unversioned API breaks existing clients. Controllers should be marked with explicit version attributes.

Incorrect

[ApiController]
[Route("api/users")]
public class UsersController : ControllerBase
{
}

Correct

[ApiController]
[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/users")]
public class UsersController : ControllerBase
{
}

Fix

Add the [ApiVersion] attribute and include the version segment in the route.