嗯我们只有最新版本,赶紧去兼容吧
不进行版本控制很有可能让 API 变得混乱因此现在很少人会不做 API 版本控制了。而这里我们选择同时在 URI 和 HTTP Header 中标记版本。下面让我们来看一个例子:
假设我们正在为我们的 MightyList 应用构建一个 API可以通过这个 API 来请求一组数据:
这是一个很小的变动,但却会破坏我们 API 的向后兼容性像这种比较小,但却会造成向后兼容性问题的变动是应该进行版本号上的变动的。
还有一种就是比较重大的修改比如:lists 变成了 superlists,又需要加入许多新的字段等等这种大的升级基本都会破坏兼容性。这时通常做法都是将 URI 中的 /v1/ 变为 /v2/
因此理论上只要是影响到向后兼容性的妀动都应该反应在版本号上,提供 Change Log 给使用者但如果不论变动大小都升级 URI 中的版本号,这又会造成过多的版本
这样我们就可以为 API 提供更噺日志了,用户也可以通过配置版本日期来访问他们需要的 API 版本就像这样:
当然 API 设计有许多不同的理念和做法,这里也只是其中一种戓许能对你有所启发。
▼点击阅读原文获取文中链接
发布了52 篇原创文章 · 获赞 26 · 访问量 9万+