在确保 api 使用和不使用 api 版本时如何消除路由名称冲突？

Question

我想将 asp.net api-versioning 应用到我的 web 应用程序（没有版本控制）。 然而，棘手的问题是我必须确保 API 可以在有和没有 api 版本的情况下工作。

    [ApiVersion("1.0")]
    [Route("api/products/{productId}/[controller]")]
    [Route("api/v{version:apiVersion}/products/{productId}/[controller]")]
    [ValidateModel]
    [Produces("application/json")]
    public partial class ProductController : ControllerBase {

        internal const string GetLatestRoute = "GET Product/GetLatestAsync";

        [HttpGet(Name = GetLatestRoute)]
        public async Task<IActionResult> GetLatestAsync() {
        
        }
    }

我有一个带有多个动作的控制器，每个动作都定义了一个唯一的路由名称。 当我向控制器添加两条路由（有和没有版本）时，会出现路由名称冲突错误：

具有相同名称“GET Products/GetLatestAsync”的属性路由必须具有相同的模板：

操作：'Service.Controllers.ProductController.GetLatestAsync (ProductFD)' - 模板：'api/products/{productId}/Product'

操作：'Service.Controllers.ProductController.GetLatestAsync (ProductFD)' - 模板：'api/v{version:apiVersion}/products/{productId}/Product'

StackOverflow 上有几个答案说这个问题可以通过删除为操作方法定义的路由名称来解决。 但是，在我的场景中，路由名称用于在项目的多个位置创建 Url 链接。

有没有一种方法可以解决这个问题？ 我想知道我是否可以将版本附加到路由名称变量或将非版本 api 映射到 version/1.0 ...？ 另一方面，在极少数情况下我更新了控制器中的所有方法。 那么有没有可能我只在控制器的顶层定义一个路由前缀，而只在方法级别上应用 api-version？

Answer 1

路由名称和路由表不支持API 版本。 为了使其工作，您需要像您一样使用双路由注册，因为您是按 URL 段进行版本控制（不推荐）。 如果客户端正确跟踪服务器返回的链接，则始终使用其中包含显式版本的路由即可。 如果客户端不遵守这一点，而只是在没有 API 版本的情况下直接调用 API，则第二个模板将为您处理。 如果您只生成具有相同控制器的链接，那么我建议改用CreatedAtAction因为它不依赖于路由名称。 如果没记错的话，您可以指定每个[Route]的优先顺序。 如果未指定，它将是指定的第一个属性 - 这很重要。

您还需要启用：

services.AddApiVersioning(options => options.AssumeDefaultVersionWhenUnspecified = true);

如果你还没有。

最后但并非最不重要的一点是，要注意已知的重大更改： 从控制器操作名称中删除的 Async 后缀。 这让很多人陷入了困境。