[发明专利]一种接口文档追平方法及相关装置

说明书

本申请提供了一种接口文档追平方法及相关装置，该方法包括:文本读取模块读取并存储git上的当前接口文本；文本读取模块根据当前接口文本分别对应的批次和系统，将当前接口文本中归属于同一目标批次且归属于同一目标系统的接口文本进行合并处理，得到针对目标系统和目标批次的目标接口文档；前端展示模块对目标接口文档进行前端展示。通过上述方法，能够实现接口文档的自动追平，降低追平成本，提高追平效率。

技术领域

本申请涉及软件开发技术领域，具体涉及一种接口文档追平方法及相关装置。

背景技术

随着计算机技术的飞速发展，项目开发的复杂度也随之增加，一个项目的开发改造，通常会涉及到多个时间点的投产，不同的时间点对项目的改造就产生了不同的产品批次，其中，各批次都有可能对项目的同一模块进行改造。

相关技术中为了提高代码开发的效率，会多个系统之间进行协助开发，这需要各个系统之间共同定义接口并编写对应的接口文档，后续各个系统项目组开发人员便会根据这个接口文档进行项目的开发，并在项目结束前都会对接口文档进行维护。

由于在项目开发中，多个批次可能对需要对同一接口文档进行修改，为了保证修改的有效性，前一个批次修改的内容既要添加到所属批次的接口文档中，还需要添加到后面批次的接口文档中，以实现接口文档的批次追平。

相关技术中主要通过两个系统之间人工沟通来进行接口文档的批次追平。具体来说，项目的接口文档，是其中一个系统编写请求，另一个系统编写返回的形式，对同一个接口文档进行修改反馈的形式进行的。这种方式虽然能够实现接口文档的批次追平，但是一方面，不同系统人工修改同一份接口文档，并且进行沟通反馈，会导致人工成本较高；另一方面，当同一时间窗口的开发涉及多个批次任务时，涉及到同一个接口文档的修改，人工会难以进行接口文档的追平，甚至会因为追平问题导致系统间对接失败等问题。

发明内容

本申请实施例提供了一种接口文档追平方法及相关装置，能够实现接口文档的自动追平，降低追平成本，提高追平效率。

有鉴于此，本申请实施例第一方面提供一种接口文档追平方法，包括：

文本读取模块读取并存储分布式版本控制系统git上的当前接口文本；

所述文本读取模块根据所述当前接口文本分别对应的批次和系统，将所述当前接口文本中归属于同一目标批次且归属于同一目标系统的接口文本进行合并处理，得到针对所述目标系统和所述目标批次的目标接口文档；

前端展示模块对所述目标接口文档进行前端展示。

本申请实施例第二方面提供一种接口文档追平装置，包括：

文本读取模块，用于读取并存储分布式版本控制系统git上的当前接口文本；根据所述当前接口文本分别对应的批次和系统，将所述当前接口文本中归属于同一目标批次且归属于同一目标系统的接口文本进行合并处理，得到针对所述目标系统和所述目标批次的目标接口文档；

前端展示模块，用于对所述目标接口文档进行前端展示。

本申请实施例第三方面提供一种电子设备，包括：

存储器，用于存储可执行指令；

处理器，用于执行所述存储器中存储的可执行指令时，实现本申请实施例提供的接口文档追平方法。

本申请实施例第四方面提供一种计算机可读介质，存储有可执行指令，用于被处理器执行时，实现本申请实施例提供的接口文档追平方法。