版本WCF Web API的最佳方法是什么?

时间:2012-01-16 19:52:40

标签: c# .net wcf api versioning

我目前有一个WCF Web API,我将其拆分为两个版本。第一个版本在api.mysite.com上运行。第二个目前尚未发布到生产中。

我想要一种方法来发布第二个API,以便对第一个版本的请求不会中断。我的想法是添加x-api-version标头并在内部将请求路由到指定的API。如果没有标头,则默认为版本1.我考虑将/v1/v2添加到路径的开头以分隔版本,以便对v1或v2的请求可能如下所示:

http://api.mysite.com/v1/authentication/login
http://api.mysite.com/v2/auth/login

唯一需要注意的是,没有版本的请求必须正常工作,默认为版本1(或我指定的任何版本)。

虽然这听起来不错(至少对我来说),但我不确定推荐的实现方法是什么。我知道我总是可以做某种反向代理但是,我希望我的解决方案可以是一个程序化的解决方案。服务器部分所需的配置越少越好。如果有人对博客/教程有任何想法或链接,那就太棒了!

提前致谢!

2 个答案:

答案 0 :(得分:5)

微软有一篇关于使用WCF here

进行版本控制的文章

答案 1 :(得分:1)

好的,我很享受到目前为止我收到的答案(非常感谢你们)但是,鉴于我对API的限制和目标,它并没有完全解决我的问题。所以,我想详细说明我找到并计划使用的解决方案。

首先,我通过URI对我的API进行版本控制。这意味着API的各种版本将如下所示:

http://api.mysite.com/authentication/login
http://api.mysite.com/v1/authentication/login
http://api.mysite.com/v2/auth/login
http://api.mysite.com/v3/auth/letmeinplease
... you get the point ...

这里要注意的重要一点是,如果我不包含版本号,那么我默认为版本1.这将是我当前的设置,但它可以很容易地默认为最新版本,最新稳定等

我们走了。我创建了一个应用程序将在其中存活的文件夹(wwroot/api)。在该文件夹中,我为所有版本创建了文件夹:v1,v2等。现在,在IIS(7.5对我来说)中,我创建了一个新项目,其应用程序根目录为wwroot/api/v1。然后我添加了每个版本文件夹(包括v1)作为子应用程序。这允许我通过URI对API进行版本化(如上所示),但有一点需要注意。

Web.config继承真的很痛苦。所以,我确保为我的所有api版本禁用它。可以找到有关如何执行此操作的参考here。除此之外,一切都像魅力一样! : - )