开发 API 涉及大量工作,从规划到实现。拥有一个清晰易懂的版本控制策略对于避免混淆开发人员至关重要。在本周的文章中,我们将探讨 API 的不同版本控制策略。

我们将首先检查为什么需要对 API 进行版本控制,以及何时需要发布新版本。我们还将调查各种版本控制策略、如何标记 API 版本,以及如何优雅地淘汰过时的 API 版本。

所以,事不宜迟,让我们直接进入正题。

为什么需要 API 版本控制

当我们为 API 添加新功能、修复现有问题或更改 API 的工作方式时,我们需要在不干扰用户的情况下交付这些更改。让我们通过一个例子来理解这一点。

假设我们有一个用于天气预报的 API。成千上万的网站使用它来构建仪表板和其他应用程序。

假设我们想更改响应对象的数据合同。这可能涉及重命名字段、添加新字段或更改整个数据合同。如果我们更改现有字段名称,我们用户的应用程序可能会停止工作或开始抛出错误。

API 版本控制示例

为了解决这个问题,我们必须要求所有用户更新他们的应用程序以配合我们的最新更改。如果这种情况经常发生,我们的用户会感到沮丧。

版本控制解决了这个问题。当我们想要发布重大更改时,我们升级 API 的版本。我们发布它的方式让用户可以选择何时接受更改。

一旦客户端开始使用我们的 API,他们就依赖它按最初设计的方式工作。如果我们在不考虑客户需求的情况下进行更改或发布新版本,可能会导致问题。这就是为什么对 API 进行版本控制并让客户选择在准备好时升级很重要。

这就是为什么为 API 设计变更至关重要。我们应该使用版本控制以清晰、一致和记录良好的方式向用户交付更改。

本文为学习目的的个人翻译,译文仅供参考。

原文链接:A Crash Course in API Versioning Strategies

版权归原作者或原刊登方所有。本文为非官方译本;如有不妥,请联系删除。