API管理:从基础到未来实践
1. API版本管理与变更管理基础
API消费者需要跟踪版本,能够找到旧版本并了解版本之间的变更说明。为了让API及其版本更易于查看和理解,一种可行的方法是要求API记录所有版本。通过API提供版本历史,能让其更易于发现,使消费者可以了解API版本信息,甚至理解其在产品历史中的演变。
对于API的重大变更,情况会变得更加棘手。因为此时API实现可能已完全改变,很难随时保持文档和版本的可发现性。在这种情况下,提供支持会有所帮助,这样API团队就无需额外花费精力保留旧版本,而是可以依靠平台仍然提供一些信息,或者告知消费者某个旧版本仍然存在,但详细信息已不再可用。
1.1 变更管理
变更管理是API生命周期的重要支柱之一。API发展过程中,应尽量减少对API生态系统的干扰。常见的做法有两种:一是遵循围绕可扩展性模型的变更管理原则,只进行符合这些模型的安全变更;二是不更改已发布的API,而是采用一种可并行运行多个不同版本的运营模式。
规划变更是API平台及其持续发展的核心问题,因此变更管理很大程度上依赖于API平台如何通过指导和工具支持API变更。为了帮助单个API进行变更管理,词汇表、速度、可见性和版本控制等方面最为相关。
1.2 词汇表
在考虑API变更管理时,要注意词汇表演变对API演变的影响。词汇表是API设计中常见且重要的方面,将词汇表设计到API中意味着词汇表的更新会导致API的更新。即使使用正确的扩展模型,这些更新是非破坏性的,但仍会触发更新API及其相关资源的整个流程,API消费者可能也需要进行类似操作。
词汇表管理也可以与API解耦,
超级会员免费看
订阅专栏 解锁全文

被折叠的 条评论
为什么被折叠?



