http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html
html
这篇文章写得很好,介绍了三种实现web api版本化的三种方式。我从评论里又收集到两种方式,因此一共是5种:web
方式一:利用URLspring
HTTP GET: https://haveibeenpwned.com/api/v2/breachedaccount/foo
方式二:利用用户自定义的request headerjson
HTTP GET: https://haveibeenpwned.com/api/breachedaccount/foo api-version: 2
方式三:利用content typeapi
HTTP GET: https://haveibeenpwned.com/api/breachedaccount/foo Accept: application/vnd.haveibeenpwned.v2+json
方式四:利用content typemvc
HTTP GET: https://haveibeenpwned.com/api/breachedaccount/foo Accept: application/vnd.haveibeenpwned+json; version=2.0
这个方式和方式三的小不一样的地方是,把版本号分离出来了。app
方式五:利用URL里的parameter网站
HTTP GET: https://haveibeenpwned.com/api/breachedaccount/foo?v=2
做者说他最喜欢第三种方式,由于版本控制
URL不用改变rest
客户端应该经过accept header来代表本身想接收的是什么样的数据。
但做者很蛋疼地在他的网站上把前面三种方式都实现了,并且都支持。
https://haveibeenpwned.com/API/v2
我我的最喜欢的是第二种方式,由于这个用spring mvc实现最容易,也最简洁。
由于只要在Controler上用@RequestMapping标明版本便可。不用再去各类匹配,各类识别。
若是是本身写一个Annotation来识别的话,也要花些功夫,并且怎么无缝地转发到原有的Spring mvc的配置也是个问题。
@Controller @RequestMapping(headers="apt-version=2") public class TestControllerV2 { }
另外这个网站列举了不少国外的有名网站是如何实现web api版本控制的。
http://www.lexicalscope.com/blog/2012/03/12/how-are-rest-apis-versioned/