Web API 版本控制的几种方式

Bertha 。 2022-08-05 02:43 205阅读 0赞

这篇文章写得很好，介绍了三种实现web api版本化的三种方式。我从评论里又收集到两种方式，所以一共是5种：

方式一：利用URL

**\[html\]**  [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  HTTP GET:  
2.  https://haveibeenpwned.com/api/v2/breachedaccount/foo

方式二：利用用户自定义的request header

**\[plain\]**  [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  HTTP GET:  
2.  https://haveibeenpwned.com/api/breachedaccount/foo  
3.  api-version: 2

方式三：利用content type

**\[plain\]**  [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  HTTP GET:  
2.  https://haveibeenpwned.com/api/breachedaccount/foo  
3.  Accept: application/vnd.haveibeenpwned.v2+json

方式四：利用content type

**\[plain\]**  [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  HTTP GET:  
2.  https://haveibeenpwned.com/api/breachedaccount/foo  
3.  Accept: application/vnd.haveibeenpwned+json; version=2.0

这个方式和方式三的小不同的地方是，把版本号分离出来了。

方式五：利用URL里的parameter

**\[plain\]**  [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  HTTP GET:  
2.  https://haveibeenpwned.com/api/breachedaccount/foo?v=2

作者说他最喜欢第三种方式，因为

1.  URL不用改变
2.  客户端应该通过accept header来表明自己想接收的是什么样的数据。

但作者很蛋疼地在他的网站上把前面三种方式都实现了，而且都支持。

https://haveibeenpwned.com/API/v2

我个人最喜欢的是第二种方式，因为这个用spring mvc实现最容易，也最简洁。

因为只要在Controler上用@RequestMapping标明版本即可。不用再去各种匹配，各种识别。

如果是自己写一个Annotation来识别的话，也要花些功夫，而且怎么无缝地转发到原有的Spring mvc的配置也是个问题。

**\[java\]**  [view plain][] [copy][view plain] [![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  @Controller  
2.  @RequestMapping(headers="apt-version=2")  
3.  **public** **class** TestControllerV2 \{  
4.  \}

另外这个网站列举了很多国外的有名网站是如何实现web api版本控制的。

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

[view plain]: http://blog.csdn.net/hengyunabc/article/details/20506345#
[CODE]: https://code.csdn.net/assets/CODE_ico.png
[CODE_CODE]: https://code.csdn.net/snippets/219492
[ico_fork.svg]: https://code.csdn.net/assets/ico_fork.svg
[ico_fork.svg 1]: https://code.csdn.net/snippets/219492/fork