接口管理方法、装置、电子设备以及可读存储介质与流程

1.本发明实施例涉及计算机技术领域，尤其涉及一种接口管理方法、装置、电子设备以及可读存储介质。


背景技术：

2.当前，对于软件的开发基本都采用前端与后端分离的方式，其基本流程大致为：后端开发者定义接口以提供数据服务，开发者通过开发页面调用接口以获取数据并渲染页面。由此，接口文档就显得十分重要。
3.现有的接口管理系统，至少可以分为两类：第一类是纯文档型，系统仅有编辑查看的功能，仅仅是用来前后端接口定义沟通，功能较单一，使用不便；第二类是系统型，有对接口的各种管理，支持一些接口的导入导出，拥有权限控制。现有的接口管理系统均存在当后端开发者根据多个不同需求对同一个接口文档进行修改时，基于不同需求的多个接口定义在同一接口文档中相互覆盖（即：接口文档中有且只能有一个需求被定义）的问题，致使现有软件的开发效率低、开发成本高。


技术实现要素：

4.本发明实施例提供一种接口管理方法，以解决现有技术中当后端开发者根据不同需求对同一个接口文档进行修改时，基于不同需求的多个接口定义在同一接口文档中相互覆盖的问题。
5.为了解决上述技术问题，本发明是这样实现的：第一方面，本发明实施例提供了一种接口管理方法，包括：接收到后端开发者对同一接口文档的多个修改需求之后，获取所述接口文档所在的分支为主分支；复制和保存所述主分支为多个开发分支，所述开发分支的数量与所述修改需求的数量相等，并且，每个所述开发分支均具有与所述主分支相同种类和数量的接口文档；将多个所述开发分支一一对应地分配给多个所述修改需求；接收到对所述开发分支中的接口文档的修改完成通知之后，将具有修改完成的所述接口文档的所述开发分支组合形成开发分支集合；接收到开发者发出的第一指令之后，根据所述第一指令确定第一开发分支，所述第一指令用于指示所述开发分支集合中的一分支为所述第一开发分支；将所述第一开发分支部署至开发软件中，以使得所述开发软件运行时能够调用所述第一开发分支中修改完成的所述接口文档。
6.可选地，将所述第一开发分支部署至开发软件中，之后还包括：接收到开发者发出的第二指令之后，根据所述第二指令确定第二开发分支，所述第二指令用于在所述开发分支集合中指示出所述第二开发分支；基于开发者根据所述第二开发分支对所述开发软件进行的修改，修改后的所述开
发软件能够实现所述第二开发分支中修改完成的所述接口文档的功能。
7.可选地，将所述第一开发分支部署至开发软件中，之后还包括：接收到开发者发出的第三指令之后，根据所述第三指令获取所述第一开发分支中修改完成的所述接口文档，并将所述第一开发分支中修改完成的所述接口文档发送到与开发者关联的开发端。
8.可选地，将所述第一开发分支中修改完成的所述接口文档发送到与开发者关联的开发端，包括：对所述接口文档进行解析，将解析结果发送至所述开发端的开发界面上。
9.可选地，基于开发者根据所述第二开发分支对所述开发软件进行的修改，包括：接收到开发者发出的第四指令之后，根据所述第四指令获取所述第二开发分支中修改完成的所述接口文档，并对所述第二开发分支中修改完成的所述接口文档进行解析；将解析结果发送至与开发者关联的开发端的开发界面上。
10.第二方面，本发明实施例提供了一种接口管理装置，包括：接收模块，用于接收到后端开发者对同一接口文档的多个修改需求之后，获取所述接口文档所在的分支为主分支；切分模块，用于复制和保存所述主分支为多个开发分支，所述开发分支的数量与所述修改需求的数量相等，并且，每个所述开发分支均具有与所述主分支相同种类和数量的接口文档；分配模块，用于将多个所述开发分支一一对应地分配给多个所述修改需求；修改模块，用于接收到对所述开发分支中的接口文档的修改完成通知之后，将具有修改完成的所述接口文档的所述开发分支组合形成开发分支集合；结合模块，用于接收到开发者发出的第一指令之后，根据所述第一指令确定第一开发分支，所述第一指令用于指示所述开发分支集合中的一分支为所述第一开发分支；部署模块，用于将所述第一开发分支部署至开发软件中，以使得所述开发软件运行时能够调用修改完成的所述接口文档。
11.可选地，所述结合模块，用于接收到开发者发出的第二指令之后，根据所述第二指令确定第二开发分支，所述第二指令用于在所述开发分支集合中指示出所述第二开发分支；所述部署模块，用于基于开发者根据所述第二开发分支对所述开发软件进行的修改，修改后的所述开发软件能够实现所述第二开发分支中修改完成的所述接口文档的功能。
12.可选地，获取模块，用于接收到开发者发出的第三指令之后，根据所述第三指令获取所述第一开发分支中修改完成的所述接口文档，并将所述第一开发分支中修改完成的所述接口文档发送到与开发者关联的开发端；解析模块，用于对所述接口文档进行解析，将解析结果发送至所述开发端的开发界面上。
13.第三方面，本发明实施例提供了一种电子设备，包括处理器，存储器及存储在所述存储器上并可在所述处理器上运行的程序或指令，所述程序或指令被所述处理器执行时实
现如第一方面中任一项所述的接口管理方法中的步骤。
14.第四方面，本发明实施例提供了一种可读存储介质，所述可读存储介质上存储程序或指令，所述程序或指令被处理器执行时实现如第一方面中任一项所述的接口管理方法中的步骤。
15.在本发明实施例中，通过在接收到后端开发者对同一接口文档的多个修改需求之后，获取所述接口文档所在的分支为主分支，复制和保存所述主分支为多个开发分支，将多个所述开发分支一一对应地分配给多个所述修改需求，解决了多个接口定义在同一接口文档中相互覆盖的问题，提高了软件的开发效率、降低了软件的开发成本。
附图说明
16.通过阅读下文优选实施方式的详细描述，各种其他的优点和益处对于本领域普通技术人员将变得清楚明了。附图仅用于示出优选实施方式的目的，而并不认为是对本发明的限制。而且在整个附图中，用相同的参考符号表示相同的部件。在附图中：图1为本发明实施例接口管理方法的流程示意图之一；图2为本发明实施例接口管理方法中复制和保存主分支为多个开发分支的示意图；图3为采用本发明实施例接口管理方法的软件系统的内部结构示意图；图4为本发明实施例接口管理方法的流程示意图之二；图5为本发明实施例接口管理方法的流程示意图之三；图6为本发明实施例接口管理方法的流程示意图之四；图7为本发明实施例接口管理装置的内部结构示意图；图8为本发明实施例电子设备的内部结构示意图。
具体实施方式
17.下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。
18.本发明实施例提供一种接口管理方法，参见图1所示，图1为本发明实施例接口管理方法的流程示意图之一，包括：步骤11：接收到后端开发者对同一接口文档的多个修改需求之后，获取接口文档所在的分支为主分支；步骤12：复制和保存主分支为多个开发分支，开发分支的数量与修改需求的数量相等，并且，每个开发分支均具有与主分支相同种类和数量的接口文档；步骤13：将多个开发分支一一对应地分配给多个修改需求；步骤14：接收到对开发分支中的接口文档的修改完成通知之后，将具有修改完成的接口文档的开发分支组合形成开发分支集合；步骤15：接收到开发者发出的第一指令之后，根据第一指令确定第一开发分支，第一指令用于指示开发分支集合中的一分支为第一开发分支；
步骤16：将第一开发分支部署至开发软件中，以使得开发软件运行时能够调用第一开发分支中修改完成的接口文档。
19.分支开发包括：1、主干开发，在这种模式下，开发人员几乎总是签入代码到主干，而使用分支的情况极少。2、按发布创建分支，在这种模式下，在某个版本即将发布之前，创建一个分支，该发布版本的测试和验证全部在该分支上进行，而最新的开发工作仍旧在主干上进行。3、按功能特性创建分支，这种模式是为了让开发团队更容易在“特性”层次上并行工作，并保持主干的可发布状态。每个用户故事或者特性在不同的分支上开发完成，一个故事只有通过测试人员验证无问题后，才会被合并到主干上，以确保主干一直是可发布的。该模式的动因是希望一直保持主干的可发布状态。4、按团队创建分支，这种模式试图解决如下状况：在一个大型团队里，有很多开发人员同时工作在多个工作单元上，并且还要维持主干总是处于可发布状态。
20.本发明的一些实施例中，可选地，参见图2所示，图2为本发明实施例接口管理方法中复制和保存主分支为多个开发分支的示意图，基于多个修改需求对各自对应开发分支中接口文档的修改，以及对第一开发分支的选择，能够实现至少实现以下一项功能：接口导入、接口导出、接口数据的mock、接口调试、以及接口的编辑查看。例如，开发者对于第一开发分支的选择是以实现接口调试为目的，此时，第一开发分支中修改完成的接口文档所对应的修改需求是用于完善上一个软件开发版本中报错部分的需求。
21.本发明的一些实施例中，可选地，开发者对于第一开发分支的选择可以是以实现接口导入为目的，此时，第一开发分支中修改完成的接口文档所对应的修改需求是用于解决软件开发所亟待解决的问题的需求。
22.本发明的一些实施例中，可选地，开发者对于第一开发分支的选择可以是实现接口数据的mock为目的。
23.mock测试就是在测试过程中，对于某些不容易构造或者不容易获取的对象，用一个虚拟的对象来创建以便测试的测试方法。这个虚拟的对象就是mock对象。mock对象是真实对象在调试期间的代替品，真实对象具有不可确定的行为，产生不可预测的效果，（如：股票行情，天气预报）真实对象很难被创建的、真实对象的某些行为很难被触发、真实对象实际上还不存在的（和其他开发小组或者和新的硬件打交道）等等。使用一个接口来描述这个对象。在产品代码中实现这个接口，在测试代码中实现这个接口，在被测试代码中只是通过接口来引用对象，所以它不知道这个引用的对象是真实对象，还是mock对象。
24.本发明的一些实施例中，可选地，参见图3所示，图3为采用本发明实施例接口管理方法的软件系统的内部结构示意图，其中：产品层面：可以按照分组=》项目=》分支=》接口四层设计。
25.技术层面：项目分支和开发流的分支概念一致，有主分支，有基于主分支保存和复制出来的开发分支，每个分支有该项目下对应分支的全部接口，开发时使用的是各自的开发分支，使得接口文档和当前需求一一对应。将关于接口的功能点从之前的基于项目调整为基于项目中的某一分支。
26.功能层面：1. 分组层：可对分组添加成员并设置成员角色，不同角色拥有不同权限。
27.2. 项目层：1）项目拥有唯一key值；2）可对项目添加成员并设置成员角色，不同角色拥有不同权限；3）提供openapi提供对接api进行分支接口的导入导出删除，且openapi不进行登录态校验，仅进行唯一key值的校验；4）支持界面操作进行分支接口导入导出。
28.3. 分支层：项目中的接口都是按照分支进行分类存储的，用于承接项目和接口。
29.4. 接口层：接口支持常规的查看编辑；支持数据mock为前端开发时提供数据服务，支持接口调试，为后端开发时提供调试服务。
30.openapi，api的全称是应用编程接口（application programming interface），这并不是一个新概念，在计算机操作系统出现的早期就已经存在了。在互联网时代，把网站的服务封装成一系列计算机易识别的数据接口开放出去，供第三方开发者使用，这种行为就叫做开放网站的api，与之对应的，所开放的api就被称作openapi。
31.在本发明实施例中，通过在接收到后端开发者对同一接口文档的多个修改需求之后，获取所述接口文档所在的分支为主分支，复制和保存所述主分支为多个开发分支，将多个所述开发分支一一对应地分配给多个所述修改需求，解决了多个接口定义在同一接口文档中相互覆盖的问题，提高了软件的开发效率、降低了软件的开发成本。
32.本发明的一些实施例中，可选地，参见图4所示，图4为本发明实施例接口管理方法的流程示意图之二，将第一开发分支部署至开发软件中，之后还包括：步骤21：接收到开发者发出的第二指令之后，根据第二指令确定第二开发分支，第二指令用于在开发分支集合中指示出第二开发分支；步骤22：基于开发者根据第二开发分支对开发软件进行的修改，修改后的开发软件能够实现第二开发分支中修改完成的接口文档的功能。
33.本发明的一些实施例中，可选地，开发者对于第二开发分支的选择可以是根据第二开发分支中修改完成的接口文档所对应的修改需求，例如，该修改需求可以是用于解决软件开发所亟待解决的问题的需求，但该问题需要被解决的优先级低于第一开发分支中修改完成的接口文档对应的修改需求所针对的问题；该修改需求可以是用于完善上一个软件开发版本中报错部分的需求，但该报错部分需要被完善的优先级低于第一开发分支中修改完成的接口文档对应的修改需求所针对的报错部分。
34.本发明的一些实施例中，可选地，第二开发分支可以是一个分支，也可以是多个分支。
35.本发明的一些实施例中，可选地，参见图5所示，图5为本发明实施例接口管理方法的流程示意图之三，将第一开发分支部署至开发软件中，之后还包括：步骤31：接收到开发者发出的第三指令之后，根据第三指令获取第一开发分支中修改完成的接口文档，并将第一开发分支中修改完成的接口文档发送到与开发者关联的开发端。
36.本发明的一些实施例中，可选地，参见图5所示，图5为本发明实施例接口管理方法的流程示意图之三，将第一开发分支中修改完成的接口文档发送到与开发者关联的开发端，包括：
步骤32：对接口文档进行解析，将解析结果发送至开发端的开发界面上。
37.上述设置使得开发者能够查看第一开发分支中修改完成的接口文档，有利于及时调整对接口文档、发现修改问题。
38.本发明的一些实施例中，可选地，参见图6所示，图6为本发明实施例接口管理方法的流程示意图之四，基于开发者根据第二开发分支对开发软件进行的修改，包括：步骤41：接收到开发者发出的第四指令之后，根据第四指令获取第二开发分支中修改完成的接口文档，并对第二开发分支中修改完成的接口文档进行解析；步骤42：将解析结果发送至与开发者关联的开发端的开发界面上。
39.上述设置使得开发者能够查看第二开发分支中修改完成的接口文档，有利于及时调整对接口文档、发现修改问题。
40.本发明实施例提供一种接口管理装置50，参见图7所示，图7为本发明实施例接口管理装置50的内部结构示意图，包括：接收模块51，用于接收到后端开发者对同一接口文档的多个修改需求之后，获取接口文档所在的分支为主分支；切分模块52，用于复制和保存主分支为多个开发分支，开发分支的数量与修改需求的数量相等，并且，每个开发分支均具有与主分支相同种类和数量的接口文档；分配模块53，用于将多个开发分支一一对应地分配给多个修改需求；修改模块54，用于接收到对开发分支中的接口文档的修改完成通知之后，将具有修改完成的接口文档的开发分支组合形成开发分支集合；结合模块55，用于接收到开发者发出的第一指令之后，根据第一指令确定第一开发分支，第一指令用于指示开发分支集合中的一分支为第一开发分支；部署模块56，用于将第一开发分支部署至开发软件中，以使得开发软件运行时能够调用修改完成的接口文档。
41.本发明的一些实施例中，可选地，参见图7所示，图7为本发明实施例接口管理装置的内部结构示意图，结合模块55，还用于接收到开发者发出的第二指令之后，根据第二指令确定第二开发分支，第二指令用于在开发分支集合中指示出第二开发分支；部署模块56，还用于基于开发者根据第二开发分支对开发软件进行的修改，修改后的开发软件能够实现第二开发分支中修改完成的接口文档的功能。
42.本发明的一些实施例中，可选地，参见图7所示，图7为本发明实施例接口管理装置的内部结构示意图，接口管理装置50还包括：获取模块57，用于接收到开发者发出的第三指令之后，根据第三指令获取第一开发分支中修改完成的接口文档，并将第一开发分支中修改完成的接口文档发送到与开发者关联的开发端。
43.解析模块58，用于对接口文档进行解析，将解析结果发送至开发端的开发界面上。
44.本发明的一些实施例中，可选地，参见图7所示，图7为本发明实施例接口管理装置的内部结构示意图，获取模块57，还用于接收到开发者发出的第四指令之后，根据第四指令获取第二开发分支中修改完成的接口文档，并对第二开发分支中修改完成的接口文档进行解析；
解析模块58，还用于将解析结果发送至与开发者关联的开发端的开发界面上。
45.本技术实施例提供的接口管理装置能够实现图1至图6的方法实施例实现的各个过程，并达到相同的技术效果，为避免重复，这里不再赘述。
46.本发明实施例提供了一种电子设备60，参见图8所示，图8为本发明实施例电子设备60的内部结构示意图，包括处理器61，存储器62及存储在存储器62上并可在处理器61上运行的程序或指令，程序或指令被处理器执行时实现本发明的任一项接口管理方法中的步骤。
47.本发明实施例提供了一种可读存储介质，可读存储介质上存储程序或指令，程序或指令被处理器执行时实现如上述任一项的接口管理方法的实施例的各个过程，且能达到相同的技术效果，为避免重复，这里不再赘述。
48.其中，所述的可读存储介质，如只读存储器（read-only memory，简称rom）、随机存取存储器（random access memory，简称ram）、磁碟或者光盘等。
49.上面结合附图对本发明的实施例进行了描述，但是本发明并不局限于上述的具体实施方式，上述的具体实施方式仅仅是示意性的，而不是限制性的，本领域的普通技术人员在本发明的启示下，在不脱离本发明宗旨和权利要求所保护的范围情况下，还可做出很多形式，均属于本发明的保护之内。