CN109857480B - 一种管理api接口地址的方法及系统 - Google Patents

Abstract

本发明涉及一种管理API接口地址的方法及系统，所述方法包括：获取目标项目和相关项目，建立目标项目和所述相关项目的绑定关系，依据绑定关系添加API接口地址，调用相关项目的API接口地址进行使用，所述管理系统包括获取模块、关系绑定模块、地址绑定模块和调用模块，解决了需要多个研发人员配合测试人员进行项目测试的问题，能够对不同项目的API接口地址进行统一管理，能够对API接口地址灵活调用，避免了项目版本发布造成API接口地址混乱。

Description

一种管理API接口地址的方法及系统

技术领域

本发明属于计算机技术领域，特别涉及一种管理API接口地址的方法及系统。

背景技术

随着计算机业务变化频繁，软件项目的迭代速度快，各项目所用的代码系统会采用主干多分支的管理方式，一般使用的开放源代码的版本控制系统为git、svn中的一种。随着业务模块的详细区分，不同的项目专注于某一方面的功能服务。

在新项目的开发、环境测试时，为了版本控制方便，代码管理清晰，会新建分支进行开发，各系统间相互调用指定分支地址进行交互，需要对接系统的研发人员协助调整应用程序编程接口(API接口)的调用地址，当新的项目版本提测后，需要对接系统的研发人都修改一次应用程序编程接口(API接口)地址，需要浪费很大的人力去修改；在修改过程中会出现修改地址错误，或者修改后忘记发布代码到测试环境，造成测试无效；如果新项目较急，或者在非工作日内提测，难以找到其他项目内的操作人员协助，不仅测试进度不能保证，而且会耽误项目正常排期上线；目前解决办法是新项目内的研发人员手动模拟一个接口，在项目内自己请求自己的系统，由于模拟接口不够准确，难以形成完善的交互过程，难以根据交互问题来完善本次项目，导致项目上线的风险较大；并且各系统端的API接口地址混乱，经常不知道调用的地址是哪个版本，严重影响测试进度和测试效果。

发明内容

针对上述问题，本发明提供了一种管理API接口地址的方法及系统。

一种管理API接口地址的方法，所述方法包括：

获取目标项目和相关项目；

对所述目标项目和所述相关项目建立绑定关系；

依据绑定关系添加所述目标项目的API接口地址和所述相关项目的API接口地址；

调用所述相关项目的API接口地址。

进一步地，所述目标项目和/或所述相关项目的获取包括：先获取所述目标项目和/或所述相关项目的项目列表信息；

再获取所述目标项目和/或所述相关项目的版本信息。

进一步地，所述相关项目的版本信息和/或所述目标项目的版本信息包括获取项目版本的主干信息和分支信息。

进一步地，所述绑定关系的建立包括：

建立所述目标项目与所述相关项目的单向绑定关系；

建立所述相关项目与所述目标项目的单向绑定关系。

进一步地，所述相关项目的API接口地址的调用包括：

所述相关项目API接口地址的调用包括：

识别所述目标项目的调用请求；

调用对应请求的所述相关项目API接口地址，并将所述相关项目API接口地址返回所述目标项目。

进一步地，所述方法还包括对所述绑定关系、所述目标项目API接口地址和相关项目API接口地址进行存储。

一种管理API接口地址的系统，

所述管理系统包括获取模块、关系绑定模块、地址绑定模块和调用模块；

获取模块，用于获取目标项目和相关项目版本信息；

关系绑定模块，用于建立目标项目与相关项目之间的绑定关系；

地址绑定模块，用于依据所述绑定关系添加所述目标项目的API接口地址和所述相关项目的API接口地址；

调用模块，用于调用所述相关项目的API接口地址。

进一步地，所述获取模块包括项目获取单元和拉取单元：

所述项目获取单元用于获取项目列表信息；

所述拉取单元用于获取项目的版本信息。

进一步地，所述绑定关系为目标项目与相关项目之间的双向绑定。

进一步地，所述管理系统还包括存储服务模块，所述存储服务模块用于存储所述绑定关系、所述目标项目的API接口地址和所述相关项目的API接口地址。

进一步地，所述获取模块通过版本控制系统获取所述目标项目和所述相关项目。

本发明的接口管理方法能够在新的项目版本提测后，只需一人在后台管理系统配置好的绑定关系即可，无需通知各端研发人员调整API接口地址，极大的节省了人力同时规避了修改错误或者通知遗漏等问题，能够保证相关项目随时提测，无需相关系统操作人员进行配合，规范了各端API接口地址的管理，节省人工成本。本发明的其它特征和优点将在随后的说明书中阐述，并且，部分地从说明书中变得显而易见，或者通过实施本发明而了解。本发明的目的和其他优点可通过在说明书、权利要求书以及附图中所指出的结构来实现和获得。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作一简单地介绍，显而易见地，下面描述中的附图是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1示出了本发明实施例管理方法流程图；

图2示出了本发明实施例管理系统结构图；

图3示出了本发明实施例管理系统运行图；

图4示出了本发明实施例的目标项目版本测试时的调用流程图。

具体实施方式

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

一种管理管理API接口地址的方法，如图1所示，登录管理系统的账号，进入管理系统。

本实施例管理系统账号的设置能够确保工作人员进入系统中，避免非操作人员误删或更改管理系统内数据，进入管理系统后进行以下操作步骤。

步骤一：获取目标项目和相关项目；

建立绑定关系前，需要通过版本控制系统先在测试环境中获取目标项目和与目标项目对接的相关项目，才能建立绑定关系。

目标项目和相关项目的获取均通过：先获取目标项目或相关项目的项目列表信息；再获取目标项目或相关项目的版本信息，且版本信息包括该项目的主干信息和分支信息。

步骤二：对目标项目和相关项目建立绑定关系；

由于绑定关系为目标项目和相关项目的双向绑定，需要建立两次绑定，两次绑定具体为：在先获取目标项目、后获取相关项目建立一次绑定，此时绑定主体为目标项目；再先获取相关项目、后获取目标项目建立一次绑定，此时绑定主体为相关项目。每次建立的单向绑定关系均会进行存储服务，并且在存储服务内进行整合形成目标项目与相关项目的双向绑定。

示例性的：目标项目为项目A的一个新版本，由于项目A有多个版本，将最新的项目A2.1版本发布到测试环境中后，可以通过版本控制系统找到项目A2.1版本，项目B有多个版本如B2.4、B2.5等，新项目A2.1作为目标项目需要与相关项目B2.5进行对接时，需要通过版本控制系统找到项目B2.5，获取版本信息后，建立“A2.1—B2.5”之间的单向绑定。

为了保证目标项目版本与相关项目版本之间的交互，需要再次建立相关项目与目标项目之间的绑定，具体过程为：通过版本控制系统获取出相关项目版本信息后，再通过版本控制系统在测试环境中拉取需要对接的目标项目版本信息，从而建立相关项目与目标项目之间的绑定。示例性的：先获取相关项目B2.5的版本星星，再获取目标项目A2.1版本信息，建立“B2.5—A2.1”的单向绑定。

经过两次单向绑定后整合成目标项目与相关项目之间的双向绑定，确认了两个项目之间的交互许可，并将双向绑定关系进行存储服务。示例性的：“A2.1—B2.5”和“B2.5—A2.1”均建立后，整合成“A2.1═B2.5”双向绑定关系，并将该“A2.1═B2.5”绑定关系存储在存储服务中。

若目标项目A2.1需与项目C1.6版本、项目D2.8版本进行对接，同样需要建立绑定关系，先检索A2.1版本拉取C1.6版本建立单向绑定关系，再检索C1.6版本、拉取A2.1版本建立单向绑定关系，整合成“A2.1═C1.6”绑定关系，进行存储。同样将目标项目A2.1与项目D2.8版本建立“A2.1═D2.8”绑定关系，并进行存储。

步骤三：依据绑定关系添加目标项目API接口地址与相关项目API接口地址。

目标项目与相关项目之间的交互需要通过相关项目的API接口实现数据传输，地址绑定之前相关人员会对各项目设置API接口地址。建立目标项目与相关项目的绑定关系后，将目标项目的API接口地址与相关项目API接口地址添加到存储服务中的绑定关系下，并且将二者的API接口地址存储后形成目标项目API接口地址与相关项目API接口地址的相互映射。示例性的：目标项目A2.1设置API接口地址为076，相关项目B2.5的API接口地址设置为083，则将076和083均存储到“A2.1═B2.5”绑定关系中，形成“A2.1076═B2.5083”映射。

步骤四：调用相关项目的API接口地址。

目标项目在测试时会向本实施例管理系统发出调用请求，管理系统识别请求后在存储服务中依据设置好的存储关系调用所需要的API接口地址。

示例性的：测试时，目标项目A2.1向本实施例管理系统请求调用项目B2.5的API接口地址，本实施例管理系统中的调用模块识别调用请求后在存储服务中识别“A2.1═B2.5”绑定关系，在该绑定关系的服务中调用API接口地址083，并将083的接口地址返回给调返回给项目A2.1，项目A2.1会依据083的API接口地址与项目B进行对接。

通过本管理方法对不同项目的API接口地址统一管理，有效避免了接口混乱，提高了项目测试的效率。

依据本实施例管理方法建立的管理API接口地址系统，如图2所示，本实施例管理系统包括获取模块、关系绑定模块、地址绑定模块、存储服务模块和调用模块，获取模块与关系绑定模块相连接，关系绑定模块、地址绑定模块和调用模块均与存储服务模块相连接。

目标项目需要平台内其他相关项目配合时，需要目标项目与相关项目进行交互，交互过程不仅需要目标项目对相关项目开放，同样需要相关项目对目标项目进行开放。因此在项目测试之前需要通过本实施例管理系统将目标项目与相关项目进行绑定，实现双方的交互认可。建立绑定关系后，即可通过绑定关系实现双方项目API接口地址相互映射。目标项目测试时，只需通过本实施例管理系统调用出相关项目的API接口地址即可。

本实施例管理系统还设置了登录模块，登录模块用于确认后台测试人员使用本管理系统，登录模块包括输入单元和认证单元，输入单元用于确认相关工作人员输入员工账号，输入后的账号信息传输给认证单元，认证单元会读取账号信息是否符合设定要求，符合要求，则可进入本实施例系统进行下一步操作，若不符合要求则不允许进入本实施例系统。示例性的，认证单元设定的要求为：员工账号为6位数，且账号以大写字母开头，若输入账号不符合6位数，或账号中不含大写字母，则会停留在输入界面中并提示账号错误。登录模块的设置有效避免无关人员使用本实施例管理系统，防止内部数据被更改或删除。

工作人员通过登录模块认证通过后会进入本实施列管理系统，在测试之前进入本管理系统的获取模块中，利用获取模块找到待测试的目标项目和与目标项目对接的其他相关项目。

获取模块与应用平台内的版本控制系统相连接，获取模块包括项目获取单元和拉取单元。

项目获取单元用于获取应用平台中的项目列表，其中包括待测试项目的项目列表。当测试系统中发布了测试项目的版本后，可利用项目获取单元与版本控制系统的连接，检索到测试环境中所需要的目标项目。通过项目获取单元获取项目列表后，选择待需要测试的项目作为目标项目。

拉取单元用于获取选定目标项目的版本信息。

具体的，利用拉取单元通过版本控制系统选择需要配置的项目，即可选择目标项目的版本或其他相关项目的版本，获取目标项目或其他相关项目的主干及分支信息。版本控制系统用于管理应用平台内所有项目的版本控制，版本控制是实现项目持续迭代开发和协同工作的常用手段。一个项目的代码版本通常包括主干和分支版本，主干版本是项目的基线，即trunk版本，包括项目的总体框架和新增功能(或已经稳定的新增功能)，并在后续持续更新的分支版本是从主干复制而来，基于该复制版本，将后续修改提交到该分支版本，而不影响trunk版本，从而保证项目开发过程中不影响主干功能。示例性的，测试系统中的车商打款项目有trunk、1.0分支、1.2分支和2.0分支，需要选取需要测试的车商打款项目2.0分支版本时，获取车商打款项目2.0版本中的主干和分支信息：trunk、1.0分支、1.2分支和2.0分支，根据测试需求选择2.0分支，该分支既包括2.0分支生成以前的主版本上的已有功能，也包括新增的测试目标功能。同样的，选择与获取车商打款项目相关的其他项目版本时，需要选择能够与获取车商打款项目2.0分支对接关联项目的主干或者分支版本。

项目获取单元检索系统中的不同项目列表。拉取单元用于检索选定项目的主干及分支信息，选定的项目可以是待测试项目或者待测试项目需要对接的相关项目。

关系绑定模块用于建立目标项目与相关项目之间的单向绑定关系，关系绑定模块接收到拉取项目单元传输的目标项目版本信息和相关项目版本信息后，会对目标项目和相关项目添加绑定关系，并将绑定关系传输给存储服务模块。

为了保证目标项目与相关项目之间的交互，需要通过关系绑定模块对目标项目与相关项目建立两次绑定关系，实现双方的双向绑定。两次绑定关系中的绑定主体不同，分别以目标项目作为绑定主体和以相关项目作为绑定主体进行绑定关系的建立。

当目标项目作为绑定主体时，相关项目为目标项目需要对接的项目。先通过项目获取单元获取平台内目标项目的项目列表，利用拉取单元选择需要测试的目标项目版本信息，再通过项目获取单元获取该相关项目的项目列表并利用拉取单元选择需要对接的该相关项目版本信息。将目标项目版本信息和相关项目版本信息传输给关系绑定模块后，关系绑定模块会建立“目标项目—相关项目”的绑定关系，并将“目标项目—相关项目”关系传输给存储服务模块。

当相关项目作为绑定主体时，需要对接目标项目。先通过项目获取单元获取相关项目的项目列表，利用拉取单元获取该相关项目的版本信息后，再利用获取单元获取目标项目的项目列表并通过拉取单元获取需要测试的目标项目版本信息。传输给关系绑定模块，关系绑定模块会建立“相关项目—目标项目”的绑定关系，并将“相关项目—目标项目”绑定关系传输给存储服务模块。

存储服务模块，用于存储绑定关系。存储服务模块接收“目标项目—相关项目”和“相关项目—目标项目”的单向绑定后进行整合形成“目标项目═相关项目”双向绑定关系，即完成目标项目与相关项目之间的绑定。

地址绑定模块用于添加目标项目的API接口地址和相关项目的API接口地址。地址绑定模块与存储服务模块相连接，在地址绑定模块中添加API接口地址后，地址绑定模块会在存储服务模块获取“目标项目═相关项目”的绑定关系，再依据绑定关系将目标项目的API接口地址和相关项目的API接口地址传输给存储服务模块。

存储服务模块中存储了目标项目与相关项目绑定关系、目标项目的API接口地址和相关项目的API接口地址。

图3示出了本发明实施例管理系统结构运行图，如图3所示，测试人员登录到本实施例管理API接口地址的后台系统内，利用本管理系统获取目标项目版本信息和相关项目版本信息后，建立项目之间的绑定关系，通过本系统内的绑定关系添加各项目对应的API接口地址，即可实现各项目API接口地址之间的映射。

调用模块与存储服务模块相连接，用于调用存储服务模块中的API接口地址。图4示出了目标项目测试时的调用流程图，如图4所示，目标项目测试时需要向本管理系统发送所需相关项目的API接口地址调用请求，调用模块识别调用请求后，在存储服务模块中调用相对应的API接口地址。

示例性的，在车辆交易平台中的线上商城开发了新的车商打款项目，需要对新的车商打款项目进行测试，将打款项目发布到测试环境中。项目获取单元和拉取单元均与车辆交易平台中的版本控制系统连接。由于车商打款项目与车辆交易平台中的超级宝项目关联，打款完成后线上商城需要给超级宝项目推送成交任务，同时超级宝项目在完成成交任务后需要通知线上商城任务已完成，因此需要建立超级宝项目与车商与打款项目之间的关系。

需要获取超级宝项目的API接口地址之前，测试人员进入本实施例管理系统中利用获取模块通过版本控制系统先找到获取车商打款项目的项目列表，再获取所需要测试车商打款项目版本信息，获取到待测试的目标项目为车商打款项目2.0版本后，获取模块会将车商打款项目2.0发送给关系绑定模块，再返回获取模块找到超级宝项目获取需要对接的相关项目版本信息为超级宝项目1.6版本，并发送给绑定模块，由绑定模块建立“车商打款项目2.0—超级宝项目1.6”的单向绑定关系。还需要在获取模块中先获取超级宝项目1.6版本，再获取车商打款项目2.0版本，依次传输给关系绑定模块后，建立“超级宝项目1.6—车商打款项目2.0”的单向绑定。

将单向绑定关系发送给存储服务模块后，存储模块会整合成“车商打款项目2.0═超级宝项目1.6”双向绑定关系。

绑定关系建立后进行车商打款项目2.0和超级宝项目1.6的API接口地址添加，在地址绑定模块内输入车商打款项目2.0的API接口地址503、超级宝项目1.6的API接口地址208后，地址绑定模块会先在存储服务模块获取“车商打款项目2.0═超级宝项目1.6”绑定关系，再直接将503和208存储在该绑定关系的存储服务模块中，形成“车商打款项目2.0503═超级宝项目1.6208”的API接口地址相互映射。

车商打款项目2.0测试时向本实施例管理系统请求超级宝项目1.6的API接口地址，本实施例管理系统识别后，在“车商打款项目2.0═超级宝项目1.6”绑定关系下调用“208”接口地址返回给车商打款项目2.0，车商打款项目2.0在测试时即可立即获得超级宝项目1.6的API接口地址进行使用。

通过本实施例管理系统，对不同项目的API接口地址进行统一管理，能够对API接口地址灵活调用，避免了版本发布造成API接口地址混乱。只需单人即可实现各项目之间的绑定，无需他人配合，无需考虑工作时间，有效保证了项目测试的进度。

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

Claims (8)

1.一种管理API接口地址的方法，其特征在于，所述方法包括：

获取目标项目和相关项目，包括：先获取发布到测试环境中所述目标项目和所述相关项目的项目列表信息；再获取所述目标项目和所述相关项目的版本信息；

对所述目标项目和所述相关项目建立绑定关系，包括：建立所述目标项目与所述相关项目的单向绑定关系；建立所述相关项目与所述目标项目的单向绑定关系；经过两次单向绑定后整合成目标项目与相关项目之间的双向绑定，确认了两个项目之间的交互许可，并将双向绑定关系进行存储服务；

依据绑定关系添加所述目标项目的API接口地址和所述相关项目的API接口地址；

调用所述相关项目的API接口地址，包括：目标项目在测试时向管理系统发出调用请求，管理系统识别请求后在存储服务中依据设置好的存储关系调用所需要的API接口地址。

2.根据权利要求1所述的管理API接口地址的方法，其特征在于，所述相关项目的版本信息和所述目标项目的版本信息包括获取项目版本的主干信息和分支信息。

3.根据权利要求1所述的管理API接口地址的方法，其特征在于，所述相关项目API接口地址的调用包括：

识别所述目标项目的调用请求；

调用对应请求的所述相关项目API接口地址，并将所述相关项目API接口地址返回所述目标项目。

4.根据权利要求1-3中任一项所述的管理API接口地址的方法，其特征在于，所述方法包括对所述绑定关系、所述目标项目的API接口地址和相关项目的API接口地址进行存储。

5.一种管理API接口地址的系统，其特征在于，管理系统包括获取模块、关系绑定模块、地址绑定模块和调用模块；

获取模块，用于获取目标项目和相关项目版本信息，包括：先获取发布到测试环境中所述目标项目和所述相关项目的项目列表信息；再获取所述目标项目和所述相关项目的版本信息；

关系绑定模块，用于建立目标项目与相关项目之间的绑定关系，包括：建立所述目标项目与所述相关项目的单向绑定关系；建立所述相关项目与所述目标项目的单向绑定关系；经过两次单向绑定后整合成目标项目与相关项目之间的双向绑定，确认了两个项目之间的交互许可，并将双向绑定关系进行存储服务；

地址绑定模块，用于依据所述绑定关系添加所述目标项目的API接口地址和所述相关项目的API接口地址；

调用模块，用于调用所述相关项目的API接口地址，包括：目标项目在测试时会向管理系统发出调用请求，管理系统识别请求后在存储服务中依据设置好的存储关系调用所需要的API接口地址。

6.根据权利要求5所述的管理API接口地址的系统，其特征在于，所述获取模块包括项目获取单元和拉取单元：

所述项目获取单元用于获取项目列表信息；

所述拉取单元用于获取项目的版本信息。

7.根据权利要求5所述的管理API接口地址的系统，其特征在于，所述管理系统还包括存储服务模块，所述存储服务模块用于存储所述绑定关系、所述目标项目的API接口地址和所述相关项目的API接口地址。

8.根据权利要求5-7中任一项所述的管理API接口地址的系统，其特征在于，所述获取模块通过版本控制系统获取所述目标项目和所述相关项目。

Images