[发明专利]应用于开发分支的接口同步方法、装置及电子设备

说明书

本发明提供一种应用于开发分支的接口同步方法、装置及电子设备，方法包括：后端系统接收到后端开发者对注释编辑完成的指令之后，根据所述编辑完成的注释，以及获取到的接口平台指定的文件格式，生成数据交换文件；将所述数据交换文件上传至接口平台；前端系统从所述接口平台获取与所述后端开发者的开发分支对应的所述数据交换文件，其中，每一开发分支对应一个数据交换文件；前端系统根据所述接口平台指定的文件格式，从所述数据交换文件中提取接口信息，并将所述接口信息发送至与前端开发者关联的开发分支页面。本发明实现同一开发分支中接口信息的自动化同步，也避免了不同开发分支的接口信息相互干扰，提高了软件开发效率。

技术领域

本发明实施例涉及计算机技术领域，尤其涉及一种应用于开发分支的接口同步方法、装置及电子设备。

背景技术

当前，对于软件的开发基本都采用前端与后端分离的方式，其基本流程大致为：后端开发者定义接口以提供数据服务，前端开发者通过开发页面调用接口文档以获取接口信息并渲染页面。

当前，还存在开发分支的模式，即：将一项目分成若干开发分支，将接口文档复制与开发分支数量相等的多份，并且将多份接口文档一一对应地分配给开发分支。

在开发分支的模式下，后端开发者在对接口信息进行更改之后，需要人工将与更改之后的接口信息对应的接口文档发送给前端开发者，还需要人工避免发送错误造成不同开发分支之间接口信息的干扰，开发效率低。

发明内容

本发明实施例提供一种应用于开发分支的接口同步方法，以解决在开发分支的模式下，后端开发者在对接口信息进行更改之后，需要人工将与更改之后的接口信息对应的接口文档发送给前端开发者，还需要人工避免发送错误造成不同开发分支之间接口信息的干扰，开发效率低的问题。

为了解决上述技术问题，本发明是这样实现的：

第一方面，本发明实施例提供了一种应用于开发分支的接口同步方法，包括：

后端系统接收到后端开发者对注释编辑完成的指令之后，根据所述编辑完成的注释，以及获取到的接口平台指定的文件格式，生成数据交换文件；将所述数据交换文件上传至接口平台；

前端系统从所述接口平台获取与所述后端开发者的开发分支对应的所述数据交换文件，其中，每一开发分支对应一个数据交换文件；

前端系统根据所述接口平台指定的文件格式，从所述数据交换文件中提取接口信息，并将所述接口信息发送至与前端开发者关联的开发分支页面。

可选地，

后端系统采用持续集成CI方式将所述数据交换文件上传至接口平台。

可选地，

后端系统采用持续集成CI方式将所述数据交换文件上传至接口平台，包括：

运行开发软件以识读所述数据交换文件，判定所述数据交换文件的文件格式是否与所述接口平台指定的文件格式类型相同；

若是，将所述数据交换文件上传至所述接口平台；

若不是，转换所述数据交换文件的文件格式以使得其与所述接口平台指定的文件格式类型相同，将转换格式后的所述数据交换文件上传至所述接口平台。

可选地，

所述开发软件至少是以下一项软件的二次开发软件：Apifox、Eolink、Yapi以及Swagger。

可选地，

所述接口平台指定的文件格式为json格式。

可选地，

所述接口平台为Openapi接口平台，所述接口平台的文件格式为Openapi 2.0；或，所述接口平台的文件格式为Openapi 3.0。

第二方面，本发明实施例提供了一种应用于开发分支的接口同步装置，包括：

前端系统和后端系统；