Api版本控制

版本控制是计算机软件行业人士使用的术语。但进化是咱们全部人都要经历的事情，它适用于这个世界上的每一个对象。
在计算机软件行业，能够看到每3至4年，每台计算机软件都会附带不一样的发行版/版本，以知足当前/现代的要求。

版本控制是建立和管理软件产品的多个版本的实践，消费者能够根据本身的需求决定使用哪一个版本，API的管理也是如此。
API的建立始终始于使应用程序与内部/外部应用程序开发人员集成的想法。就像任何其余传统软件产品同样，它老是从小规模开始，而且会随着时间而发展。让咱们看下面的简单用例，以更好地理解它。
例如，咱们可能但愿使内部/外部应用程序开发人员可以访问客户信息，而且可能开始建立API以提供所需的功能。
做为第一个版本，您能够为API提供仅对客户信息的读取权限。后来，随着对应用程序需求的增长，您的应用程序开发人员可能会请求对客户信息的“写入/更新”访问权限。做为API建立者/开发者，您能够决定是否：

1. 提供具备对客户信息的写入/更新访问权限的同一API的新版本
2. 彻底提供单独的API，以提供对客户信息的写入/更新访问权限
   API的通用设计原则是使用第一种方法-从应用程序开发人员的角度来看，为咱们提供相同功能的API的新版本，以及咱们处理同一实体（客户）时的附加功能。这将致使具备相同API的2个版本：
   • CustomerInfo v1.0-提供对客户信息的只读访问
   • CustomerInfo v2.0 —提供对客户信息的读/写/更新访问
   

经过API的版本控制，CustomerInfo API的使用者能够根据须要决定使用哪一个版本。
当咱们想支持同一个API的多个版本时，做为API建立者/设计者，咱们须要考虑如下02个主要设计决策：
• 指定API版本信息的格式是什么
• 消费者将如何指定所选API的API版本
选择用于指定版本信息的格式时，能够选择如下02种常见作法：
• 使用发布/构建日期-这容许使用发布/构建日期来惟一标识每一个版本。
示例—版本=“ 20200808” | 版本=“ 20190102”

• 使用major.minor数字 -这些数字用于指定同一API的不一样版本，而且该数字能够包含1或2或3位数字做为版本号的一部分。一些API开发人员使用“ v”前缀来表示它是版本号。
示例— version =“ 1” | 版本=“ v1” | 版本=“ 1.1” | 版本=“ v1.1” | 版本=“ 1.1.1” | 版本=“ v1.1.1”

在决定使用者如何指定版本信息时，能够从如下03种常见作法中进行选择：
• HTTP标头-自定义HTTP标头将用于传递API版本信息
示例— x-customerinfoapi-version：2.1

• 查询参数-API版本信息将做为查询参数传递
示例-/customerinfo?version=2.1

• URL -API版本信息将合并到URL自己
示例-/ v2 / customerinfo

做为API的建立者/开发者，咱们还能够结合上面的一些方法，并提供用于提供API版本信息的混合方法。例如，咱们可使用URL方法来指定主要版本，而可使用HTTP标头方法来指定API的次要版本。
如您所见，API版本控制是API设计/开发中的关键功能，而且做为API提供程序，使消费者可以在不一样的API版本之间进行选择是关键的业务差别。