API设计确保向后兼容性

时间:2012-01-18 09:02:11

标签: api backwards-compatibility

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

3 个答案:

答案 0 :(得分:7)

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

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

答案 1 :(得分:7)

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

How to Design a Good API and Why it Matters

答案 2 :(得分:3)

执行此操作的最佳方法是将新版本中的旧接口或类保留为新接口和类,并将其标记为已弃用(表示将在以后的版本中删除这些接口或类)。

听取API设计人员记住公共接口和已发布接口之间的区别。