c# - Microsoft.AspNetCore.Mvc.Versioning如何默认为 "latest"版本

Question

除了在构建新版本时更改 startup.cs 之外，

services.AddApiVersioning(config =>
{
    config.DefaultApiVersion = new ApiVersion(1, 0);
});

有没有办法指定“默认版本”是最新版本，而不指定该版本是什么？例如某种说法

config.DefaultApiVersion = new ApiVersionLatest();

. . .还是这与 RESTApi 众神认为神圣的一切背道而驰？

谢谢

Answer 1

正确 答案在一定程度上取决于您期望实现的目标。 DefaultApiVersion 仅在没有其他 API 版本可用时才起作用。 API 版本控制没有“无 API 版本” 的概念。 API version-neutral 意味着 API 接受任何和所有 API 版本，包括完全不接受。 默认 API 版本也可以被认为是初始 API 版本。

下面是 DefaultAPIVersion 发挥作用的几个场景:

• Controller 没有应用归因或约定
• 选择可能的 API 版本没有结果

听起来您似乎有兴趣在一个地方配置最新的 API 版本。您可以使用DefaultApiVersion 来执行此操作，但前提是 Controller 没有其他属性或约定。如果某个 API 没有继承，您将必须使用指示旧 API 版本的属性或约定显式修饰 Controller ，以将其从最新 版本中排除。虽然这是可能的，但很难遵循 IMO。

更好的方法可能是使用描述您想要的行为的扩展。例如:

[AttributeUsage( AttributeTargets.Class, AllowMultiple = false )]
public sealed class LatestApiVersionAttribute : ApiVersionAttribute, IApiVersionProvider
{
  public LatestApiVersionAttribute() : base( new ApiVersion( 2, 0 ) ) { }
}

现在你可以把它应用到你所有的 Controller 上了:

[LatestApiVersion]
public class MyController : ControllerBase
{
  // ommitted
}

这让您有机会在单一位置管理最新的 API 版本。您也可以考虑使用约定，这样您甚至不需要自定义属性。属性和约定可以组合。

@spender 确实提到使用自定义 IApiVersionSelector；但是，选择目前仅在未指定 API 版本时才起作用。要启用这种类型的配置，请将其设置为:

services.AddApiVersioning( options =>
{
   options.ApiVersionSelector = new CurrentImplementationApiVersionSelector( options );
   options.AssumeDefaultVersionWhenUnspecified = true;
}

这将使未指定 API 版本的客户端始终转发到所请求 API 的最新版本。客户仍然可以明确要求特定版本，包括最新版本。

希望对您有所帮助。