API 版本控制和重用版本更新的现有实现

Posted 2023-03-15

【中文标题】API 版本控制和重用版本更新的现有实现

【英文标题】：API versioning and reusing existing implementation on version updates

【发布时间】：2018-04-22 12:17:07

【问题描述】：

我们正在使用aspnet-api-version 为我们的 API 提供版本。虽然库允许在一个控制器上使用interleaving multiple version implementation。

[ApiVersion( "2.0" )]
[ApiVersion( "3.0" )]
[RoutePrefix( "api/helloworld" )]
public class HelloWorld2Controller : ApiController

    [Route]
    public string Get() => "Hello world v2.0!";

    [Route, MapToApiVersion( "3.0" )]
    public string GetV3() => "Hello world v3.0!";

我们希望将特定于版本的控制器分开。

我看到的版本特定控制器和使用这个库的问题是我们必须再次重新实现所有 API 方法，无论它们是否已更改。考虑这个例子

[RoutePrefix("api/vversion:apiVersion/values")]
[ApiVersion( "1.0" )]
public class ValuesController : ApiController

    // GET api/values
    [Route]
    public IEnumerable<string> Get()
    
        return new string[]  "value1", "value2" ;
    

    // GET api/values/5
    [Route("id:int")]
    [Route, MapToApiVersion( "1.0" )]
    public string Get(int id)
    
        return id.ToString();
    



[RoutePrefix("api/vversion:apiVersion/values")]
[ApiVersion( "2.0" )]
public class ValuesControllerV2 : ValuesController

    // GET api/values/5
    [Route("id:int")]
    [Route, MapToApiVersion( "2.0" )]
    public string Get(int id)
    
        return id.ToString();
    

V1 api（使用ValuesController）定义了两个API函数Get和Get(ById)。但是 v2 api ValuesControllerV2 虽然覆盖了 Get(ById)，但它必须重新实现或调用 Get 的基本方法才能使 Get API 在 V2 上可用。

有没有更好的策略，我们不必为所有在 API 升级时保持不变的函数重新实现或编写传递。

【参考方案1】：

首先，我建议您评估一下您的版本控制政策。大多数服务作者（和/或公司）定义类似 N-2 的策略。这将帮助您确定这个问题有多大，或者它是否是一个问题。

你可以使用继承，但有龙。在 Web API 中，您需要做一些额外的事情才能使其正常工作。内置实现不支持继承的 RoutePrefixAttribute 或 RouteAttribute。您还应该考虑到您不能取消继承 操作。如果您取消 API，这会使策略变得非常混乱。并非所有版本控制方案都向后兼容或前滚。

我强烈建议您将业务逻辑保留在服务之外。通用基类非操作方法或扩展方法可以帮助减少重复代码。如果每个操作的实施规模很小，并且您有既定的版本控制策略，那么重复就不是问题。

任何一种方法或两者的组合都应该提供足够的灵活性。

【讨论】：

感谢@Chris 的反馈。