CN111124474B - 一种api版本控制方法及装置 - Google Patents

Abstract

本发明公开了一种API版本控制方法及装置。所公开的方法包括：存储不同项目、不同API的不同版本的配置文件；基于指定的项目信息、API的版本信息，动态加载指定项目、指定版本的API的配置文件，其中，配置文件包括下列信息中的至少一项：API访问路径、请求方法、请求参数、响应格式。所公开的技术方案能够快速地动态加载指定版本的API配置文件。

Description

一种API版本控制方法及装置

技术领域

本发明涉及软件工程和数据库领域，尤其涉及一种API版本控制方法及装置。

背景技术

随着计算机软件和数据库产业的快速发展，API在企业中起到的作用越来越重要。API既可以作为企业内部不同业务系统之间的桥梁，进行不同业务系统之间的数据交换或集成；也可以作为企业和合作伙伴之间的枢纽，进行数据的共享。随着企业业务的发展和变化，企业中的API也会相应随之变化，因此，API的版本控制就显得尤为重要。如何在业务变更或者遇到故障时，能够快速地切换API的版本，这将是企业数字化过程中必须解决的一个问题。

现有技术通常采用专用的代码版本控制工具(例如，git、SVN等)来对API服务的源代码进行管理，通过切换代码版本的方式来进行服务回滚和升级。

然而，现有技术方案却存在以下缺点：

1、低效：由于切换API版本时需要针对不同代码重新对API服务进行编译，会影响切换的效率。

2、冗余：无论API服务变更的大小，每次变更都需要保存全量的代码。

3、服务中断：在切换API服务版本时很可能需要服务重启，会导致服务中断。

4、依赖源码：对源码过度依赖。

为了解决上述问题，需要提出新的技术方案。

发明内容

根据本发明的API版本控制方法，包括：

存储不同项目、不同API的不同版本的配置文件；

基于指定的项目信息、API的版本信息，动态加载指定项目、指定版本的API的配置文件，

其中，配置文件包括下列信息中的至少一项：API访问路径、请求方法、请求参数、响应格式。

根据本发明的API版本控制方法，还包括：

构建分别用于存储项目信息、API属性信息、API版本信息、API扩展信息的数据实体，来存储与进行API版本控制相关的信息，

其中，与进行API版本控制相关的信息以日志方式存储在数据库中。

根据本发明的API版本控制方法，还包括：

基于项目ID字段project_id来标识项目的唯一性，基于版本ID字段version_id来标识API版本的唯一性，在用于存储API版本信息的数据实体中存储与API版本相关的信息，

其中，用于存储API版本信息的数据实体是api_version表。

根据本发明的API版本控制方法，还包括：

基于指定项目名称，确定与指定项目名称关联的project_id的值，查找与project_id的值对应的、上线状态字段status的值online所对应的、api_version表中的表项，将所查找到的表项中的status的值设置为offline，将需要动态加载的指定版本的API所对应的、api_version表中的表项中的status的值设置为online，以完成动态加载。

根据本发明的API版本控制方法，还包括：

针对同一项目，基于api_id字段来标识不同API的不同版本的配置文件的唯一性，基于uni_key字段来标识各个唯一的API配置文件是否对应于同一个API，基于api_id字段和uni_key字段来查询同一项目下的同一个API的配置文件的最新版本。

根据本发明的API版本控制装置，包括：

存储模块，用于存储不同项目、不同API的不同版本的配置文件；

动态发布模块，用于基于指定的项目信息、API的版本信息，动态加载指定项目、指定版本的API的配置文件，

其中，配置文件包括下列信息中的至少一项：API访问路径、请求方法、请求参数、响应格式。

根据本发明的API版本控制装置，其存储模块还用于：

构建分别用于存储项目信息、API属性信息、API版本信息、API扩展信息的数据实体，来存储与进行API版本控制相关的信息，

装置还包括：

数据库，用于以日志方式存储与进行API版本控制相关的信息。

根据本发明的API版本控制装置，其存储模块还用于：

基于项目ID字段project_id来标识项目的唯一性，基于版本ID字段version_id来标识API版本的唯一性，在用于存储API版本信息的数据实体中存储与API版本相关的信息，

其中，用于存储API版本信息的数据实体是api_version表。

根据本发明的API版本控制装置，其存储模块还用于：

基于指定项目名称，确定与指定项目名称关联的project_id的值，查找与project_id的值对应的、上线状态字段status的值online所对应的、api_version表中的表项，将所查找到的表项中的status的值设置为offline，将需要动态加载的指定版本的API所对应的、api_version表中的表项中的status的值设置为online，以完成动态加载。

根据本发明的API版本控制装置，其存储模块还用于：

针对同一项目，基于api_id字段来标识不同API的不同版本的配置文件的唯一性，基于uni_key字段来标识各个唯一的API配置文件是否对应于同一个API，基于api_id字段和uni_key字段来查询同一项目下的同一个API的配置文件的最新版本。

根据本发明的上述技术方案，能够快速地动态加载指定版本的API配置文件。

附图说明

并入到说明书中并且构成说明书的一部分的附图示出了本发明的实施例，并且与相关的文字描述一起用于解释本发明的原理。在这些附图中，类似的附图标记用于表示类似的要素。下面描述中的附图是本发明的一些实施例，而不是全部实施例。对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，可以根据这些附图获得其他的附图。

图1示例性地示出了根据本发明的API版本控制方法的示意流程图。

图2示例性地示出了根据本发明的技术方案可以使用的多个数据表之间的关联关系的示意图。

图3示例性地示出了根据本发明的API版本控制装置的示意框图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明的一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。需要说明的是，在不冲突的情况下，本申请中的实施例及实施例中的特征可以相互任意组合。

图1示例性地示出了根据本发明的API版本控制方法的示意流程图。

如图1的实线框所示，根据本发明的API版本控制方法，包括：

步骤S102：存储不同项目、不同API的不同版本的配置文件；

步骤S104：基于指定的项目信息、API的版本信息，动态加载指定项目、指定版本的API的配置文件，

其中，配置文件包括下列信息中的至少一项：API访问路径、请求方法、请求参数、响应格式。

例如，可以使用上述方法来对API(例如，API网关架构中所使用的webAPI)进行版本管理。

例如，上述方法能够以日志的形式来存储不同的API配置信息(即，上述配置文件)，从而能够基于API的多版本配置信息实现动态版本切换。

可选地，如图1的虚线框所示，根据本发明的API版本控制方法，还包括：

步骤S106：构建分别用于存储项目信息、API属性信息、API版本信息、API扩展信息的数据实体，来存储与进行API版本控制相关的信息，

其中，与进行API版本控制相关的信息以日志方式存储在数据库中。

可选地，如图1的虚线框所示，根据本发明的API版本控制方法，还包括：

步骤S108：基于项目ID字段project_id来标识项目的唯一性，基于版本ID字段version_id来标识API版本的唯一性，在用于存储API版本信息的数据实体中存储与API版本相关的信息，

其中，用于存储API版本信息的数据实体是api_version表。

可选地，如图1的虚线框所示，根据本发明的API版本控制方法，还包括：

步骤S110：基于指定项目名称，确定与指定项目名称关联的project_id的值，查找与project_id的值对应的、上线状态字段status的值online所对应的、api_version表中的表项，将所查找到的表项中的status的值设置为offline，将需要动态加载的指定版本的API所对应的、api_version表中的表项中的status的值设置为online，以完成动态加载。

可选地，如图1的虚线框所示，根据本发明的API版本控制方法，还包括：

步骤S112：针对同一项目，基于api_id字段来标识不同API的不同版本的配置文件的唯一性，基于uni_key字段来标识各个唯一的API配置文件是否对应于同一个API，基于api_id字段和uni_key字段来查询同一项目下的同一个API的配置文件的最新版本。

可选地，上述API是webAPI。

例如，可以按照以下设计原则定义分别用于存储项目信息、API属性信息、API版本信息、API扩展信息的四个数据实体，每个数据实体分别对应于数据库中的一个或多个数据表。

项目数据实体：用于存储与API的逻辑分组相关的信息，适用于针对多个API进行统一管理，例如，可以对应于名称为project的数据表。

API属性信息实体：用于存储API属性信息，例如，可以对应于名称为api的数据表。

API版本信息实体：用于存储API的版本信息，例如，可以对应于名称为api_version的数据表。

API扩展信息实体：用于存储与API相关的扩展信息，例如，API插件、API后端等，例如，可以对应于名称为api_extra的数据表。

例如，project、api、api_version、api_extra数据表的表结构分别包括以下字段信息：

1、project表：

project_id：项目唯一标识

project_name：项目名称

host：项目对应Host

base_uri：项目对应基础请求路径，用于对API进行逻辑隔离

2、api表：

api_id：自增ID(唯一标识)

uni_key：系统自动生成的API内部名称

project_id：API所属项目唯一标识

api_name：API名称

status：API状态，比如enabled、disabled、error等

request_method：API请求方法

request_uri：API请求路径

parameters：API参数列表

is_deleted：是否被删除

version_id：API对应的version唯一标识

3、api_version表：

version_id：唯一标识

version_name：版本号名称，例如1.1.0等

last_version_id：前一个版本的唯一标识

status：版本状态，比如online、offline等

4、api_extra表：

api_id：所属API的唯一标识

extra_id：唯一标识

extra_info：相关信息

由于API的开发过程包括设计->测试->上线->重新设计->重新测试->重新上线…的循环迭代的过程。在每次设计完毕保存后，会产生新的版本号，上线时会将新版本变更成线上版本，上线后还可以根据需求选择过去的版本进行回滚，同一时刻每个项目中只能有一个线上版本。因此，可以执行以下具体操作：

一、保存某项目的API(保存后才可以上线，对应于上述步骤S102、S106、S108)

1、根据项目的project_id，创建新的api_version数据，同时生成新的api_version唯一索引。

2、创建所有被更新的api及api相关数据，保存并设置刚创建的version_id。

A)针对新增的API，系统会生成唯一uni_key并且创建一条新api数据。

B)针对被修改的API，系统会使用原api数据的uni_key创建一条新版本的数据。

C)针对被删除的API，系统会使用原api数据的uni_key创建一条新版本的数据，并设置is_deleted为1。

二、上线或切换线上版本(对应于上述步骤S104、S110)

1、根据需要上线的项目的project_id，查找是否存在status字段为online的api_version数据，如果存在(每个项目只应该存在1条)，则将其status设置为offline。

2、将需要上线的版本号对应的api_version数据的status字段设置为online。

三、列出某版本下的API(对应于上述步骤S112)

例如，如果对于一个指定project_id的项目，其所对应的api表中的所有记录如表1所示：

表1：api表中的记录的示例

api_id	uni_key	version_id	…
				1	A	1
2	B	1
				3	A	2
4	A	3
				5	C	3
6	D	3

那么，就可以基于表1中的uni_key和api_id字段的信息列出包含该项目下的每个API的最新版本的列表，如表2所示。

表2：基于表1的记录最终列出的每个API的最新版本的列表的示例

api_id	uni_key	version_id	…
				2	B	1
4	A	3
				5	C	3
6	D	3

需要注意的是，第一步和第二步需要保证事务，从而实现这两步操作的原子性。

图2示例性地示出了根据本发明的技术方案可以使用的多个数据表之间的关联关系的示意图。

如图2所示，一个project表对应多个api表，两者之间使用project_id关联；一个api_version表对应多个api表，两者之间使用version_id关联；一个api表对应多个api_extra表，两者之间使用api_id关联。

图3示例性地示出了根据本发明的API版本控制装置300的示意框图。

如图3的实线框所示，根据本发明的API版本控制装置300，包括：

存储模块301，用于存储不同项目、不同API的不同版本的配置文件；

动态发布模块303，用于基于指定的项目信息、API的版本信息，动态加载指定项目、指定版本的API的配置文件，

其中，配置文件包括下列信息中的至少一项：API访问路径、请求方法、请求参数、响应格式。

可选地，存储模块301还用于：

构建分别用于存储项目信息、API属性信息、API版本信息、API扩展信息的数据实体，来存储与进行API版本控制相关的信息，

API版本控制装置300还包括：

数据库305，用于以日志方式存储与进行API版本控制相关的信息。

可选地，存储模块301还用于：

基于项目ID字段project_id来标识项目的唯一性，基于版本ID字段version_id来标识API版本的唯一性，在用于存储API版本信息的数据实体中存储与API版本相关的信息，

其中，用于存储API版本信息的数据实体是api_version表。

可选地，存储模块301还用于：

基于指定项目名称，确定与指定项目名称关联的project_id的值，查找与project_id的值对应的、上线状态字段status的值online所对应的、api_version表中的表项，将所查找到的表项中的status的值设置为offline，将需要动态加载的指定版本的API所对应的、api_version表中的表项中的status的值设置为online，以完成动态加载。

可选地，存储模块301还用于：

针对同一项目，基于api_id字段来标识不同API的不同版本的配置文件的唯一性，基于uni_key字段来标识各个唯一的API配置文件是否对应于同一个API，基于api_id字段和uni_key字段来查询同一项目下的同一个API的配置文件的最新版本。

可选地，上述API是webAPI。

根据本发明的上述技术方案，具有以下优点：

1、能够存储API配置文件的不同版本，无需编译，效率高。

2、可以利用api表引入uni_key字段，实现了只针对增量数据进行保存，某一版本中没有更新的api不需要额外存储一条数据记录，降低了冗余的数据。

3、能够快速地动态加载指定版本的API配置文件，不使服务中断。

4、降低了对API服务源代码的依赖，通过API网关中的API配置即可实现API版本的管理。

5、能够结合专门设计的数据实体，来高效、便捷地管理与进行API版本控制相关的信息。

6、在切换版本操作时具备更高的效率，因为所有API的配置全部存在数据库中，所以所有API的变更、版本的切换只需要动态的变更数据库中的数据即可实现，节省了切换时间。

7、可以采用动态配置实现版本无缝切换。

上面描述的内容可以单独地或者以各种方式组合起来实施，而这些变型方式都在本发明的保护范围之内。

本领域普通技术人员可以理解，上文中所公开方法中的全部或某些步骤、系统、装置中的功能模块/单元可以被实施为软件、固件、硬件及其适当的组合。在硬件实施方式中，在以上描述中提及的功能模块/单元之间的划分不一定对应于物理组件的划分；例如，一个物理组件可以具有多个功能，或者一个功能或步骤可以由若干物理组件合作执行。某些组件或所有组件可以被实施为由处理器，如数字信号处理器或微处理器执行的软件，或者被实施为硬件，或者被实施为集成电路，如专用集成电路。这样的软件可以分布在计算机可读介质上，计算机可读介质可以包括计算机存储介质(或非暂时性介质)和通信介质(或暂时性介质)。如本领域普通技术人员公知的，术语计算机存储介质包括在用于存储信息(诸如计算机可读指令、数据结构、程序模块或其他数据)的任何方法或技术中实施的易失性和非易失性、可移除和不可移除介质。计算机存储介质包括但不限于RAM、ROM、EEPROM、闪存或其他存储器技术、CD-ROM、数字多功能盘(DVD)或其他光盘存储、磁盒、磁带、磁盘存储或其他磁存储装置、或者可以用于存储期望的信息并且可以被计算机访问的任何其他的介质。此外，本领域普通技术人员公知的是，通信介质通常包含计算机可读指令、数据结构、程序模块或者诸如载波或其他传输机制之类的调制数据信号中的其他数据，并且可包括任何信息递送介质。

最后应说明的是：以上实施例仅用以说明本发明的技术方案，而非对其限制。尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例的技术方案的精神和范围。

Claims (10)

1.一种API版本控制方法，其特征在于，包括：

存储不同项目、不同API的不同版本的配置文件；

基于指定的项目信息、API的版本信息，动态加载指定项目、指定版本的API的配置文件，

其中，所述配置文件包括API访问路径，以及包括请求方法、请求参数、响应格式中的至少一项；

所述方法还包括：

构建分别用于存储项目信息、API属性信息、API版本信息、API扩展信息的数据实体，来存储与进行API版本控制相关的信息；

基于指定项目名称，将用于存储API版本信息的api_version表中与该指定项目名称对应的、处于上线状态的表项置为下线状态，将所述api_version表中需要动态加载的指定版本的API对应的表项置为上线状态，以完成动态加载。

2.如权利要求1所述的API版本控制方法，其特征在于，

所述与进行API版本控制相关的信息以日志方式存储在数据库中。

3.如权利要求1所述的API版本控制方法，其特征在于，还包括：

基于项目ID字段project_id来标识项目的唯一性，基于版本ID字段version_id来标识API版本的唯一性，在所述用于存储API版本信息的数据实体中存储与API版本相关的信息，

其中，所述用于存储API版本信息的数据实体是api_version表。

4.如权利要求3所述的API版本控制方法，其特征在于，还包括：

基于指定项目名称，确定与所述指定项目名称关联的所述project_id的值，查找与所述project_id的值对应的、上线状态字段status的值online所对应的、api_version表中的表项。

5.如权利要求1所述的API版本控制方法，还包括：

针对同一项目，基于api_id字段来标识不同API的不同版本的配置文件的唯一性，基于uni_key字段来标识各个唯一的API配置文件是否对应于同一个API，基于所述api_id字段和所述uni_key字段来查询同一项目下的同一个API的配置文件的最新版本。

6.一种API版本控制装置，其特征在于，包括：

存储模块，用于存储不同项目、不同API的不同版本的配置文件；

动态发布模块，用于基于指定的项目信息、API的版本信息，动态加载指定项目、指定版本的API的配置文件，

其中，所述配置文件包括：API访问路径，以及包括请求方法、请求参数、响应格式中的至少一项；

所述存储模块还用于：

构建分别用于存储项目信息、API属性信息、API版本信息、API扩展信息的数据实体，来存储与进行API版本控制相关的信息；基于指定项目名称，将用于存储API版本信息的api_version表中与该指定项目名称对应的、处于上线状态的表项置为下线状态，将所述api_version表中需要动态加载的指定版本的API对应的表项置为上线状态，以完成动态加载。

7.如权利要求6所述的API版本控制装置，其特征在于，

所述装置还包括：

数据库，用于以日志方式存储所述与进行API版本控制相关的信息。

8.如权利要求6所述的API版本控制装置，其特征在于，所述存储模块还用于：

基于项目ID字段project_id来标识项目的唯一性，基于版本ID字段version_id来标识API版本的唯一性，在所述用于存储API版本信息的数据实体中存储与API版本相关的信息，

其中，所述用于存储API版本信息的数据实体是api_version表。

9.如权利要求8所述的API版本控制装置，其特征在于，所述存储模块还用于：

基于指定项目名称，确定与所述指定项目名称关联的所述project_id的值，查找与所述project_id的值对应的、上线状态字段status的值online所对应的、api_version表中的表项。

10.如权利要求6所述的API版本控制装置，其特征在于，所述存储模块还用于：

针对同一项目，基于api_id字段来标识不同API的不同版本的配置文件的唯一性，基于uni_key字段来标识各个唯一的API配置文件是否对应于同一个API，基于所述api_id字段和所述uni_key字段来查询同一项目下的同一个API的配置文件的最新版本。

Images