API设计确保向后兼容性

Question

在设计API时要记住哪些最佳实践,以确保向后兼容性和新版本发布.任何指向文章/博客的链接都表示赞赏.

Answer 1

使用url中的版本保持运行.api.mysite.com/[version]/api/url/here.当新版本的API到达时通知用户,并在一段时间后删除旧版本.要么不再使用,要么用6个月保证用户有足够的时间来改变它.

或者让它永远运行,但不要为它提供任何新功能.

这基本上是我在多个项目中使用的方法。我经常看到的另一种模式是让 `api.example.com/` 指向最新版本的 API - 注意缺少版本号。不想要最新最好的客户可以随意点击版本化 URL - `api.example.com/v1/` (3认同)

Answer 2

您应该查看有关API设计的演示文稿.这是来自谷歌,相当不错.它还解决了向后兼容性和新版本.

然而仍然破碎,也许这就是那个？http://static.googleusercontent.com/media/research.google.com/en//pubs/archive/32713.pdf (2认同)