怎么做 Web API 版本控制？

价值 | 思考 | 共鸣

简评：这是 fly.io 分享的一篇文章，讲了他们是怎么对自家 REST API 做版本控制的。另外还有很多其他的技术文章，个人感觉还不错，感兴趣的同学可以看一看。

API 设计是一个都快被说烂了的主题，已经有太多关于对 Web API 做版本控制很棒的文章了。比如：

• Adding Versions to a Rails API

• Best practices for API versioning?

• Best Practices for Designing a Pragmatic RESTful API

• Your API versioning is wrong, which is why I decided to do it 3 different wrong ways

但今天这里还是想分享一篇，希望看完能有所收获。: )

API 版本控制

虽然还没有一个绝对正确的方式来设计一个 API，但是有几个关键想法是许多开发者都同意的，一个优秀的 Web API 应该是：

1. 能保证一致性和稳定性；

2. 版本的向后兼容；

3. RESTful。

为了能最好的实现这些理念，关于如何实现 API 的不同版本目前主要有三种做法：

在 URI 中标记版本

curl https://example.com/api/v2/lists/

通过解析 URI 中的版本号，客户端可以访问 /v1/ 或 /v2/ 等不同版本API。

在 Header 中标记版本

curl https://example.com/api/lists/3 \ 
-H 'Accept: application/vnd.example.v2+json'

直接不标记版本

curl https://example.com/api/lists/3

嗯，我们只有最新版本，赶紧去兼容吧

不进行版本控制很有可能让 API 变得混乱，因此现在很少人会不做 API 版本控制了。而这里，我们选择同时在 URI 和 HTTP Header 中标记版本。下面让我们来看一个例子：

假设我们正在为我们的 MightyList 应用构建一个 API，可以通过这个 API 来请求一组数据：

curl https://mightyapp.com/api/v1/lists/3
...

{
 "listId": "3",
 "shopping": "Shoes, tie, umbrella, snorkel",
 "leisure": "Skiing, surfing, snorkeling ",
 "food": "bananas, peanut butter, spinach",
 "cost": "One hundred dollars"
}

我们先来看一个小的需求变化，在上面的例子中，cost

字段返回的是一个字符串。而现在我们的开发团队希望将其变成数值类型。

curl https://mightyapp.com/api/v1/lists/3
...

{
 "listId": "3",
 "shopping": "Shoes, tie, umbrella, snorkel",
 "leisure": "Skiing, surfing, snorkeling ",
 "food": "bananas, peanut butter, spinach",
 "cost": 100
}

这是一个很小的变动，但却会破坏我们 API 的向后兼容性。像这种比较小，但却会造成向后兼容性问题的变动，是应该进行版本号上的变动的。

还有一种就是比较重大的修改，比如：lists 变成了 superlists，又需要加入许多新的字段等等，这种大的升级基本都会破坏兼容性。这时通常做法都是将 URI 中的  /v1/ 变为 /v2/ 。

因此理论上只要是影响到向后兼容性的改动都应该反应在版本号上，提供 Change Log 给使用者。但如果不论变动大小都升级 URI 中的版本号，这又会造成过多的版本。

• 为了保证我们应用状态的清晰，我们希望在 URI 中有一个代表产品版本的版本号。当产品有了较大，或根本性的改变时，URI 版本将会改变。比如，MightyList V1 使用 /api/v1/，MightyList V2 使用 /api/v2/ 。

• 而对于当前版本内的较小修改，我们使用自定义的 HTTP Header 来表示。作者使用的自定义 Header 名为 API-Version，值为 day-month-year 格式的日期。

这样我们就可以为 API 提供更新日志了，用户也可以通过配置版本日期来访问他们需要的 API 版本，就像这样：

当然 API 设计有许多不同的理念和做法，这里也只是其中一种，或许能对你有所启发。

英文原文：How to Version a Web API
旧文推荐：

Mozilla 、微软、谷歌、W3C、三星将一起构建 Web 的统一文档

用 WebGL 探索动画和交互技术（一个学习案例）

▼点击阅读原文获取文中链接