博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Web API 版本控制的几种方式
阅读量:6009 次
发布时间:2019-06-20

本文共 1225 字,大约阅读时间需要 4 分钟。

hot3.png

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

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

方式一:利用URL

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

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

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

方式三:利用content type

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

方式四:利用content type

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

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

方式五:利用URL里的parameter

HTTP GET:  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的配置也是个问题。

@Controller  @RequestMapping(headers="apt-version=2")  public class TestControllerV2 {  }

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

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

转载于:https://my.oschina.net/yafeiok/blog/614756

你可能感兴趣的文章
sql字符串插入函数STUFF
查看>>
Mybatis日志信息
查看>>
Python Shell 怎样清屏?
查看>>
How to Install Apache CouchDB on CentOS 6 (from Source and EPEL)
查看>>
命令玩转防火墙
查看>>
Centos 6 安装 Gitlab和备份、迁移
查看>>
LINUX学习笔记(四)RAID LVM
查看>>
安装Windows7 原版系统时跳过创建用户 使用administrator的方法
查看>>
zabbix-3.2.11短信报警
查看>>
Python 之 logging日志模块
查看>>
从头学Java_01
查看>>
第一天上班
查看>>
Oracle-day03 中
查看>>
CocoaPods 配置使用 - IOS依赖管理
查看>>
反射操作公共成员变量
查看>>
用户配置文件和密码配置文件、用户组管理、用户管理、usermod命令
查看>>
SpringBoot2.X最佳实践《一》 之 SpringBoot2.x初体验
查看>>
nginx
查看>>
多线程
查看>>
MyEclipse下统计工程的代码量
查看>>