天天看點

Web API 版本控制的幾種方式

http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html

這篇文章寫得很好,介紹了三種實作web api版本化的三種方式。我從評論裡又收集到兩種方式,是以一共是5種:

方式一:利用url

方式二:利用使用者自定義的request header

方式三:利用content type

方式四:利用content type

這個方式和方式三的小不同的地方是,把版本号分離出來了。

方式五:利用url裡的parameter

作者說他最喜歡第三種方式,因為

url不用改變

用戶端應該通過accept header來表明自己想接收的是什麼樣的資料。

但作者很蛋疼地在他的網站上把前面三種方式都實作了,而且都支援。

https://haveibeenpwned.com/api/v2

我個人最喜歡的是第二種方式,因為這個用spring mvc實作最容易,也最簡潔。

因為隻要在controler上用@requestmapping标明版本即可。不用再去各種比對,各種識别。

如果是自己寫一個annotation來識别的話,也要花些功夫,而且怎麼無縫地轉發到原有的spring mvc的配置也是個問題。

另外這個網站列舉了很多國外的有名網站是如何實作web api版本控制的。

http://www.lexicalscope.com/blog/2012/03/12/how-are-rest-apis-versioned/